:py:mod:`starling_sim.utils.testing`
====================================

.. py:module:: starling_sim.utils.testing


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


Functions
~~~~~~~~~

.. autoapisummary::

   starling_sim.utils.testing.get_test_scenarios
   starling_sim.utils.testing.run_model_test
   starling_sim.utils.testing.compare_scenario_outputs



Attributes
~~~~~~~~~~

.. autoapisummary::

   starling_sim.utils.testing.SIMULATION_TEST_DATA_FOLDER
   starling_sim.utils.testing.REFERENCE_OUTPUTS_FOLDER_NAME


.. py:data:: SIMULATION_TEST_DATA_FOLDER
   :value: 'tests/simulation_test_data/'

   

.. py:data:: REFERENCE_OUTPUTS_FOLDER_NAME
   :value: 'reference'

   

.. py:function:: get_test_scenarios(models=None)

   Enumerate test scenarios for the given models.

   If models is not provided, enumerate scenarios
   for all models available.

   /!\ It is expected that the data folder variable
   paths._DATA_FOLDER has already been modified to
   designate the test data folder.

   :param models: list of model codes

   :return: list of (model_code, scenario) models


.. py:function:: run_model_test(model, scenario, pkg='starling_sim')

   Run the given test scenario and compare outputs.

   Outputs are compared to reference files stored in the scenario folder.

   :param model: model code
   :param scenario: scenario folder name
   :param pkg: starling package (see --help or run.py)

   :return: boolean indicating if test was successful
   :raises: ValueError if a problem occurs


.. py:function:: compare_scenario_outputs(simulation_scenario)

   Compare test scenario outputs with files of the reference folder.

   :param simulation_scenario: SimulationScenario object
   :raises: ValueError if files don't match