usersimcrs.run_simulation
=========================

.. py:module:: usersimcrs.run_simulation

.. autoapi-nested-parse::

   Console application for running simulation.



Attributes
----------

.. autoapisummary::

   usersimcrs.run_simulation.DEFAULT_CONFIG_PATH
   usersimcrs.run_simulation.OUTPUT_DIR
   usersimcrs.run_simulation.logger
   usersimcrs.run_simulation.args


Functions
---------

.. autoapisummary::

   usersimcrs.run_simulation.main
   usersimcrs.run_simulation.parse_args
   usersimcrs.run_simulation.load_config


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

.. py:data:: DEFAULT_CONFIG_PATH
   :value: 'config/default/config_default.yaml'


.. py:data:: OUTPUT_DIR
   :value: 'data/runs'


.. py:data:: logger

.. py:function:: main(config: confuse.Configuration) -> None

   Executes the specified configuration.

   Loads domain and interaction model. Initializes agent and user. Runs the
   simulation.

   :param config: Configuration generated from YAML configuration file.


.. py:function:: parse_args() -> argparse.Namespace

   Defines accepted arguments and returns the parsed values.

   :returns: A namespace object containing the arguments.


.. py:function:: load_config(args: argparse.Namespace) -> confuse.Configuration

   Loads config from config file and command line parameters.

   Loads default values from `config/default/config_default.yaml`. Values are
   then updated with any value specified in the command line arguments.

   :param args: Arguments parsed with argparse.


.. py:data:: args