:py:mod:`starling_sim.simulation_scenario`
==========================================

.. py:module:: starling_sim.simulation_scenario

.. autoapi-nested-parse::

   This module manages the parameters of the simulation



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   starling_sim.simulation_scenario.SimulationScenario




.. py:class:: SimulationScenario(scenario_folder_path: str)


   This class describes a simulation scenario folders and data.

   .. py:attribute:: BASE_PARAM_SCHEMA
      :value: 'parameters.schema.json'

      

   .. py:method:: _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.

      :param scenario_folder_path: path to the scenario folder


   .. py:method:: 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.


   .. py:method:: __getitem__(item)

      Method called when using 'SimulationScenario[item]'

      :param item: Name of the parameter accessed
      :return: self.parameters[item]


   .. py:method:: __contains__(item)

      Method called when using 'item in simulationParameters'

      :param item:
      :return: True if item is in self.parameters, False otherwise


   .. py:method:: init_run_summary()

      Initialise the run summary.


   .. py:method:: copy_parameters()

      Return a deepcopy of the simulation parameters.

      :return: deepcopy of simulation parameters


   .. py:method:: set_stat(key, value)

      Set a value for the given stat key.

      :param key: stat key
      :param value: stat value