.. PyDHN documentation master file, created by
   sphinx-quickstart on Mon Jun  3 21:52:48 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

PyDHN
=================================

**PyDHN** is a Python library for storing, visualizing and managing District Heating Network (DHN) data, running simulations and automate I/O workflow, built on top of `Networkx <https://networkx.org/>`_. The main idea behind PyDHN is to provide a modular, object-oriented framework which prioritizes versatility.

With PyDHN you can run both steady-state and dynamic simulations, test different control strategies and implement your own components with few lines of code.


.. toctree::
   :maxdepth: 2
   :caption: Install PyDHN:

   install/install

.. toctree::
   :maxdepth: 2
   :caption: Get started:

   get_started/network
   get_started/fluids
   get_started/soil
   get_started/components
   get_started/simulation
   get_started/loops

.. toctree::
   :maxdepth: 1
   :caption: API reference:

   generated/pydhn


.. toctree::
   :maxdepth: 2
   :caption: About:

   about/references