effluent.script
===============

.. py:module:: effluent.script

.. autoapi-nested-parse::

   The module contains the main entry point of the application



Functions
---------

.. autoapisummary::

   effluent.script.init_logger
   effluent.script.main
   effluent.script.run


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

.. py:function:: init_logger(loglevel=None)

   Initialize the python logger

   :param loglevel: Desired output loglevel


.. py:function:: main()

   Main script, runnable from the command line

   The function uses the `argparse` library to parse arguments from the command line.

   :return: 0 if successful


.. py:function:: run(conf)

   Run the simulation and save the output in the specified file.

   Internally, the function creates a :class:`Model <effluent.model.Model>` object
   using the information from the config file, and calls the
   :func:`run <effluent.model.Model.run>` method of that object.

   :param conf: :doc:`Configuration parameters </config>` (dict object or file name).