.. You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to OMOTES simulator-core documentation!
===============================================
This documentation covers the OMOTES simulator, a tool designed to simulate the thermo-hydraulics of district heating systems.
Developed as part of the Dutch Nieuwe Warmte Nu program, the simulator is written in Python and uses the ESDL format as input.

For more information, visit the `NWN website`_ or the `ESDL website`_.

This documentation is divided in the following sections:

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   architecture/architecture
   solver/solver_main
   assets/assets
   controller/controller


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

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


.. _NWN website: https://www.nwn.nu/
.. _ESDL: https://www.esdl.nl/