The scenario end time (required).
The name of the scenario. The name must be unique amongst the scenarios.
The scenario start time (required). Must be formatted as 'YYYY-MM-DDThh:mm:ss'.
A list of assets used by this scenario. Assets will be used to end simulations early when a firefront reaches the shape.
A set of burning conditions.
User comments about the scenario (optional).
The scenarios display interval (required).
The FBP option values.
The FGM option values.
The FMC option values.
The FWI option values.
Options for enabling wind gusts if available in the weather stream.
A list of ignitions used by this scenario.
A list of grids used by the scenario. The list contains an index value that defines the order of the layers.
The name of the scenario that will be copied.
Conditions that will be used to end the simulation early.
A list of vectors used by this scenario.
A target used by this scenario to modify the vector behaviour.
A target used by this scenario to modify the wind direction.
Get the scenario end time as an ISO8601 string.
Set the scenario end time using a string. Cannot be null or empty. Must be formatted in ISO8601.
Get the name of the scenario.
Set the name of the scenario. Must be unique amongst the scenario collection. Cannot be null or empty.
Get the scenario end time as a Luxon DateTime.
Set the scenario end time using a Luxon DateTime. Cannot be null.
Get the scenario start time as a Luxon DateTime.
Set the scenario start time using a Luxon DateTime. Cannot be null.
Get the scenario start time as an ISO8601 string.
Set the scenario start time using a string. Cannot be null or empty. Must be formatted in ISO8601.
Add an asset file to the scenario. Must already be added to the WISE object.
The asset file to add to the scenario.
The date that the condition is valid on. Must be formatted as 'YYYY-MM-DD'.
The starting hour. Must be between 0 and 23 inclusive.
The ending hour. Must be between 1 and 24 inclusive.
The minimum FWI value that will allow burning.
The minimum wind speed that will allow burning.
The maximum relative humidity that will allow burning (as a percent [0-100]).
The minimum ISI that will allow burning.
Add an ignition to the scenario.
The ignition to add to the scenario.
Add the primary weather stream to the scenario.
The weather stream to set as the scenario's primary stream.
Add a weather grid to the scenario.
The weather grid to add to the scenario.
The layers index in the scenario.
LayerInfo The reference that was just added.
Add a weather patch to the scenario.
The weather patch to add to the scenario.
The layers index in the scenario.
LayerInfo The reference that was just added.
Add a weather stream to the scenario.
The weather stream to add to the scenario.
Find all errors that may exist in the scenario.
A list of errors that were found.
Clear the FBP options.
Clears the FGM options.
Clears the FMC options.
Clear the FWI options.
Clears the nudge to ignitions to perform probabilistic analyses on ignition location and start time.
Remove the vector target file from the scenario.
Remove the wind target file from the scenario.
Checks to see if all required values have been set.
Remove an asset file from the scenario.
Remove a BurningConditions object from the burning conditions.
The BurningConditions object to remove
A boolean indicating if the object was found and removed
Remove a FuelBreak object from the vector info.
The FuelBreak object to remove
A boolean indicating if the object was found and removed
Remove a Ignition object from the ignition info.
The Ignition object to remove
A boolean indicating if the object was found and removed
Remove a layer from the layer info.
The layer to remove
A boolean indicating if the object was found and removed
Remove the primary WeatherStream object from the stream and station info.
The WeatherStream object to remove
A boolean indicating if the object was found and removed
Remove a WeatherStream object from the stream and station info.
The WeatherStream object to remove
A boolean indicating if the object was found and removed
Set the FBP options.
Use terrain effect.
Use wind effect.
Set the FGM options.
The maximum time step during acceleration.
The distance resolution.
The perimeter resolution.
Minimum Spreading ROS.
Whether to stop the fire spread when the simulated fire reaches the boundary of the grid data.
Whether breaching is turned on or off.
Whether using the dynamic spatial threshold algorithm is turned on or off.
Whether the spotting model should be activated.
Whether internal/hidden time steps are retained.
Whether the growth percentile value is applied.
Growth percentile, to apply to specific fuel types.
Set the FMC options.
The value for the FMC (%) override. Use -1 for no override.
The elevation where NODATA or no grid exists.
No longer used, left for compatibility.
Set the FWI options.
Apply spatial interpolation to FWI values.
Calculate FWI values from temporally interpolated weather.
Apply history to FWI values affected by patches, grids, etc..
Use burning conditions.
Apply spatial interpolation to FWI values.
Set the name of the scenario. This name must be unique within the simulation. The name will get a default value when the scenario is constructed but can be overriden with this method.
How much to nudge ignitions to perform probabilistic analyses on ignition location and start time. Primarily used when ignition information is not 100% reliable.
How much to nudge ignitions to perform probabilistic analyses on ignition location.
How much to nudge ignitions to perform probabilistic analyses on ignition location.
How much to nudge ignitions to perform probabilistic analyses on ignition location and start time.
Add a target file to the scenario for vector direction. Must already be added to the WISE object.
The target file to add to the scenario.
Add a target file to the scenario for wind direction. Must already be added to the WISE object.
The target file to add to the scenario.
Streams the scenario to a socket.
A simulation scenario.
"Travis Redpath"