starling_sim.simulation_scenario
This module manages the parameters of the simulation
Module Contents
Classes
This class describes a simulation scenario folders and data. |
- class starling_sim.simulation_scenario.SimulationScenario(scenario_folder_path: str)
This class describes a simulation scenario folders and data.
- BASE_PARAM_SCHEMA = 'parameters.schema.json'
- _set_scenario_folders(scenario_folder_path: str)
Set the folder attributes from the scenario folder path.
Paths are built according to the structure enforced by the functions of starling_sim.utils.paths.
- Parameters:
scenario_folder_path – path to the scenario folder
- get_scenario_parameters()
Get and validate the scenario simulation parameters.
Also get the scenario model and name from the parameters.
The parameter file path is enforced by the scenario_parameters_filepath function.
- __getitem__(item)
Method called when using ‘SimulationScenario[item]’
- Parameters:
item – Name of the parameter accessed
- Returns:
self.parameters[item]
- __contains__(item)
Method called when using ‘item in simulationParameters’
- Parameters:
item –
- Returns:
True if item is in self.parameters, False otherwise
- init_run_summary()
Initialise the run summary.
- copy_parameters()
Return a deepcopy of the simulation parameters.
- Returns:
deepcopy of simulation parameters
- set_stat(key, value)
Set a value for the given stat key.
- Parameters:
key – stat key
value – stat value