###############################################################################
pywellsfm.simulator
###############################################################################

The :mod:`pywellsfm.simulator` package contains the forward modelling engines
(simulators) and orchestration helpers used to run stratigraphic forward
modelling scenarios.

Files documented
----------------

This page is built from the following Python modules:

* ``__init__.py`` (``pywellsfm.simulator``)
* ``AccommodationSimulator.py`` (``pywellsfm.simulator.AccommodationSimulator``)
* ``AccumulationSimulator.py`` (``pywellsfm.simulator.AccumulationSimulator``)
* ``FSSimulator.py`` (``pywellsfm.simulator.FSSimulator``)
* ``DepositionalEnvironmentSimulator.py`` (``pywellsfm.simulator.DepositionalEnvironmentSimulator``)
* ``EnvironmentConditionSimulator.py`` (``pywellsfm.simulator.EnvironmentConditionSimulator``)
* ``TimeStepController.py`` (``pywellsfm.simulator.TimeStepController``)

API reference
-------------

.. automodule:: pywellsfm.simulator
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index:

.. automodule:: pywellsfm.simulator.AccommodationSimulator
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index:

.. automodule:: pywellsfm.simulator.AccumulationSimulator
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index:

.. automodule:: pywellsfm.simulator.DepositionalEnvironmentSimulator
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index:

.. automodule:: pywellsfm.simulator.EnvironmentConditionSimulator
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index:

.. automodule:: pywellsfm.simulator.FSSimulator
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index:

.. automodule:: pywellsfm.simulator.TimeStepController
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index: