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

.. py:module:: starling_sim.utils.config

.. autoapi-nested-parse::

   This module contains a config dict with simulation related values.

   Config values can be provided to the simulator using a json file name after the _CONFIG_FILE constant.

   For a complete description of the config specification and its default values,
   see the JSON schema (schemas/starling_config.schema.json):

   .. literalinclude:: /../starling_sim/schemas/starling_config.schema.json
       :language: json



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


Functions
~~~~~~~~~

.. autoapisummary::

   starling_sim.utils.config._init_config



Attributes
~~~~~~~~~~

.. autoapisummary::

   starling_sim.utils.config._CONFIG_FILE
   starling_sim.utils.config._CONFIG_SCHEMA
   starling_sim.utils.config.config


.. py:data:: _CONFIG_FILE
   :value: 'starling_config.json'

   

.. py:data:: _CONFIG_SCHEMA
   :value: 'starling_config.schema.json'

   

.. py:function:: _init_config()

   Initialise config variables from a config file or from the default schema values.


.. py:data:: config