Metadata-Version: 2.1
Name: smartheattable
Version: 0.0.2
Summary: Smart heat table software in Python
Author-email: "Paul J.M. van Kan" <paul.vankan@han.nl>, Maarten van den Berg <maarten.vandenberg@han.nl>
Project-URL: Homepage, https://github.com/hancse/smartheattable.git
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE

smartheattable
==============

|PyPI| |Documentation Status| |PyPI - License|

A Python package for modelling a district heating network. 
The code is being developed for the AEA-BES research group at HAN University of Applied Sciences, The Netherlands. 
The **smartheattable** package can be used under the conditions of the GPLv3 license.

Features
--------

* Layout and operation of a district heating network.


Installation
------------

To use the package `smartheattable`, install it in a Python environment:

.. code-block:: console

    (env) pip install smartheattable

or

.. code-block:: console

    (env) conda install smartheattable

This should
automatically install the dependency packages ``matplotlib`` , ``scipy``
and ``pandas``, if they haven't been installed already. If you are
installing by hand, ensure that these packages are installed as well.

Example use
-----------

.. code:: python

   python -m smartheattable


smartheattable pages
--------------------

-  `PyPi <https://pypi.org/project/smartheattable/>`__: smartheattable Python package
-  `BitBucket <https://bitbucket.org/deltares/smartheattable/>`__: smartheattable source code
-  `ReadTheDocs <https://smartheattable.readthedocs.io/>`__: smartheattable documentation

Author and license
------------------

-  Author: Paul van Kan, Maarten van den Berg, Ronald van Buuren
-  Contact: paul.vankan@han.nl
-  License: `GPLv3 <https://www.gnu.org/licenses/gpl.html>`__

References
----------

-  ...

.. |PyPi| image:: https://img.shields.io/pypi/v/smartheattable
   :alt: PyPI

.. |PyPI - Downloads| image:: https://img.shields.io/pypi/dm/smartheattable
   :alt: PyPI - Downloads

.. |PyPi Status| image:: https://img.shields.io/pypi/status/smartheattable
   :alt: PyPI - Status

.. |Documentation Status| image:: https://readthedocs.org/projects/smartheattable/badge/?version=latest
   :target: https://edumud.readthedocs.io/en/latest/?badge=latest

.. |PyPI - License| image:: https://img.shields.io/pypi/l/smartheattable
   :alt: PyPI - License
