.. RTC-Tools Heat Network documentation master file, created by
   sphinx-quickstart on Wed Jul 15 13:28:40 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

RTC-Tools Heat Network's documentation
======================================

This is the documentation for RTC-Tools Heat Network, a library for model-predictive control of heat networks.
The library development was funded as part of `WarmingUP <https://www.warmingup.info>`_ project.

The documentation covers:

    - How to get it running on your computer.
    - The optimization approach, its rationale, and the underlying equations and assumptions.
    - Example use of the RTC-Tools Heat Network library.
    - An overview of the Python API, to construct your own optimization models.

.. toctree::
   :maxdepth: 2
   :caption: User Documentation

   getting-started
   support

.. toctree::
   :maxdepth: 2
   :caption: Theory

   theory/index

.. toctree::
   :maxdepth: 2
   :caption: Examples

   examples/index

.. toctree::
   :maxdepth: 2
   :caption: API Documentation

   python-api

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

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