:py:mod:`starling_sim.model_simulator`
======================================

.. py:module:: starling_sim.model_simulator


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

Classes
~~~~~~~

.. autoapisummary::

   starling_sim.model_simulator.ModelSimulator



Functions
~~~~~~~~~

.. autoapisummary::

   starling_sim.model_simulator.launch_simulation



Attributes
~~~~~~~~~~

.. autoapisummary::

   starling_sim.model_simulator.models_dict
   starling_sim.model_simulator.model_codes


.. py:data:: models_dict

   

.. py:data:: model_codes

   

.. py:class:: ModelSimulator(model)


   The simulator runs a simulation model

   .. py:attribute:: init_simulator_from_parameters

      

   .. py:attribute:: get_model_class

      

   .. py:method:: setup_simulation()

      Prepares the simulation model for running


   .. py:method:: run_simulation()

      Call the run method of the simulation model


   .. py:method:: generate_output()

      Generates an output of the simulation at its current state


   .. py:method:: init_simulator_from_parameters(simulation_scenario, pkg)
      :staticmethod:

      Returns a simulator initialised according to the model code
      contained in the given parameters

      :param simulation_scenario: SimulationParameters containing "code"
      :param pkg: name of the source package

      :return: ModelSimulator object


   .. py:method:: get_model_class(model_code, pkg)
      :staticmethod:

      Get the Model class of the simulation model.

      :param model_code: model code
      :param pkg: name of the source package

      :return: SimulationModel subclass



.. py:function:: launch_simulation(scenario_path, pkg)

   Realises the initialisation, setup, run and output of the simulation
   using the given parameters file. Displays log of execution times

   :param scenario_path: path to scenario folder
   :param pkg: name of the source package