Metadata-Version: 2.4
Name: mosaik-heatpump
Version: 1.1.0
Summary: mosaik-heatpump provides models for the simulation of heating systems
Author: Pranay Kasturi
Author-email: Pranay Kasturi <mosaik@offis.de>
License-Expression: MIT
Requires-Dist: mosaik-api-v3>=3.0.4
Requires-Dist: tespy>=0.10.2
Requires-Dist: hplib>=1.9
Requires-Dist: pandas>=3
Requires-Dist: numpy>=2.5
Requires-Python: >=3.12
Description-Content-Type: text/x-rst

mosaik-heatpump
===============

This package provides models for the simulation of heating systems- consisting of heat pumps, hot water tanks,
and controllers - and adapters for the co-simulation of these models using *mosaik*.

Installation & Tests
--------------------

You can install mosaik-heatpump with pip:

.. code-block:: bash

      pip install mosaik-heatpump

You can run the tests with:

.. code-block:: bash

      uv sync --group test
      uv run pytest tests

Documentation, Source Code and Issues
-------------------------------------

The documentation is available at `Read the Docs <https://mosaik-heatpump-docs.readthedocs.io/en/latest/>`_.


Please report bugs and ideas for improvement to our `issue tracker`__.

__ https://gitlab.com/mosaik/components/energy/mosaik-heatpump/-/issues

Get in touch, ask questions, discuss
------------------------------------

For questions and general discussion about mosaik-heatpump, you can use
`mosaik's GitHub Discussions <https://github.com/orgs/OFFIS-mosaik/discussions>`_.

Citation
--------

The model was initially used and presented `here <https://doi.org/10.1186/s42162-021-00180-6>`_ , 
but it is not described in detail. We plan to publish a paper presenting the package, and will
update this section after the publication.

Building the Documentation
--------------------------

To build the documentation locally (Unix):

.. code-block:: bash

      uv sync --group docs
      cd docs && make html

To build the documentation locally (Windows):

.. code-block:: bash

      uv sync --group docs
      .\docs\make.bat html

The documentation will be available in ``docs/_build/html/``.

License
-------

This project is licensed under the MIT License. See `LICENSE <https://gitlab.com/mosaik/components/energy/mosaik-heatpump/-/blob/master/LICENSE>`_ file for details.
