effluent
========

.. py:module:: effluent

.. autoapi-nested-parse::

   The main package contains only a single function, :func:`effluent.run`, which is the
   main entry point of the application.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/effluent/eos/index
   /autoapi/effluent/io/index
   /autoapi/effluent/model/index
   /autoapi/effluent/numerics/index
   /autoapi/effluent/roms/index
   /autoapi/effluent/script/index
   /autoapi/effluent/solver/index


Attributes
----------

.. autoapisummary::

   effluent.__version__


Functions
---------

.. autoapisummary::

   effluent.run


Package Contents
----------------

.. py:data:: __version__
   :value: '1.5.0'


   The version number


.. 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).