.. include:: ../README.rst

User's Guide
============

This part of the documentation will show you how to get started in using
ESSM.

.. toctree::
   :maxdepth: 2

   installation
   usage

Importable variables and equations
==================================

Here you find examples for importing pre-defined variables and equations 
fromm ESSM.

.. toctree::
   :maxdepth: 3

   examples/importable_variables_equations

Use examples
=============

Here you find use examples for different API features of ESSM.

.. toctree::
   :maxdepth: 3

   examples/api_features
   examples/examples_numerics

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: 3

   api

Additional Notes
================

Notes on how to contribute, legal information and changes are here for the
interested.

.. toctree::
   :maxdepth: 1

   changes
   license
   authors

References
==========

.. bibliography:: refs.bib
   :cited:

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`