.. image:: _static/pymt-logo-header-text.png
    :align: center
    :scale: 75%
    :alt: Python Modeling Tool
    :target: https://pymt.readthedocs.org/

.. title:: PyMT

*pymt* is the *Python Modeling Toolkit*.
It is an Open Source Python package, developed by the
`Community Surface Dynamics Modeling System`_ (CSDMS),
that provides the tools needed for coupling models that expose the
`Basic Model Interface`_ (BMI).

*pymt* in three points:

* Tools for coupling models of disparate time and space scales
* A collection of Earth-surface models
* Extensible plug-in framework for adding new models


What does it look like?  Here is an example of a simple *pymt* program:

.. code-block:: python

    from pymt.models import Cem, Waves

    waves = Waves()
    cem = Cem()

    waves.initialize(*waves.setup())
    cem.initialize(*cem.setup())

    for time in range(1000):
        waves.update()
        angle = waves.get_value("wave_angle")
        cem.set_value("wave_angle", angle)
        cem.update()


*pymt* is an element of the `CSDMS Workbench`_,
an integrated system of software tools, technologies, and standards
for building and coupling models.


User Guide
----------

If you are looking for information on using *pymt*
to configure, run, and couple models,
this part of the documentation is for you.

.. toctree::
   :maxdepth: 1
   :hidden:

      Summary <readme>

* :doc:`Summary <readme>`

.. toctree::
   :maxdepth: 2

   quickstart
   install
   usage
   models
   examples
   glossary


API Reference
-------------

If you are looking for information on a specific function, class, or
method, this part of the documentation is for you.

.. toctree::
   :maxdepth: 2

   api/index


Miscellaneous Pages
-------------------

.. toctree::
   :maxdepth: 2

   conda-environments
   contributing
   authors
   history
   license


Help
----

If you encounter any problems when using *pymt*,
please visit us at the `CSDMS Help Desk`_
and explain what occurred.
Or,
if you're developing with *pymt*
feel free to open an `issue`_
in the *pymt* GitHub repository.


Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

..
   Links

.. _Community Surface Dynamics Modeling System: https://csdms.colorado.edu
.. _Basic Model Interface: https://bmi.readthedocs.io
.. _CSDMS Workbench: https://csdms.colorado.edu/wiki/Workbench
.. _CSDMS Help Desk: https://github.com/csdms/help-desk
.. _issue: https://github.com/csdms/pymt/issues