.. FHEAT: District Heating Network Generator documentation master file, created by
   sphinx-quickstart on Fri Jul 19 15:20:29 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

F|Heat Documentation
====================

.. Add your content using ``reStructuredText`` syntax. See the
.. `reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
.. documentation for details.

What is the Purpose of F|Heat?
------------------------------

F|Heat is a software ecosystem for planning a sector-coupled decarbonized energy system in municipalities and small and medium-sized communities.

.. .. figure:: images/fheat_logo.png
..     :alt: fheat_logo.png
..     :width: 40 %
..     :align: center

..     F|Heat - Urban energy planning

Structure of the Documentation
------------------------------
This documentation consists of the following sections:

General Information
^^^^^^^^^^^^^^^^^^^
* :doc:`introduction`
* :doc:`access_usage`
* :doc:`installation`
   
.. toctree::
   :maxdepth: 3
   :hidden:
   :caption: General Information

   introduction
   access_usage
   installation

F|Heat Application
^^^^^^^^^^^^^^^^^^

* :doc:`fheatai_overview`
* :doc:`methodology`
* :doc:`example`

.. toctree::
   :maxdepth: 3
   :hidden:
   :caption: F|Heat

   fheatai_overview
   methodology
   example

Sourcecode Documentation and API Reference
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* :doc:`api_documentation`

.. toctree::
   :maxdepth: 3
   :hidden:
   :caption: Sourcecode Documentation

   api_documentation


Troubleshooting
^^^^^^^^^^^^^^^

* :doc:`troubleshooting`

.. toctree::
   :maxdepth: 3
   :hidden:
   :caption: Troubleshooting

   troubleshooting

Further Information
^^^^^^^^^^^^^^^^^^^

* :doc:`contact`
* :doc:`contributor`
* :doc:`oss_used`

.. toctree::
   :maxdepth: 3
   :hidden:
   :caption: Further Information

   contact
   contributor
   citation
   userlist
   license
   related_projects
   oss_used
   acknowledgements
   
.. note::

	- The current repository is located here `here <https://github.com/F-Heat>`_.

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

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