DHNx

This package provides an open toolbox for district heating and cooling network optimization and simulation models.
https://github.com/oemof/DHNx

Category: Consumption
Sub Category: Buildings and Heating

Keywords from Contributors

energy-system datapackage energy-system-modeling oemof modelling-framework

Last synced: about 5 hours ago
JSON representation

Repository metadata

District heating system optimisation and simulation models

• Host: GitHub
• URL: https://github.com/oemof/DHNx
• Owner: oemof
• License: mit
• Created: 2019-06-12T11:28:54.000Z (almost 6 years ago)
• Default Branch: dev
• Last Pushed: 2025-02-25T07:51:23.000Z (2 months ago)
• Last Synced: 2025-04-25T13:45:55.278Z (2 days ago)
• Language: Python
• Homepage:
• Size: 987 KB
• Stars: 31
• Watchers: 12
• Forks: 12
• Open Issues: 36
• Releases: 3
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

README.rst

          |badge_coverage| |readthedocs| |zenodo|

~~~~
DHNx
~~~~

This package provides an open toolbox for district heating and cooling network
optimization and simulation models.

.. contents::

About
=====

The aim of DHNx is to provide a toolbox for building models of
district heating/cooling systems. 

Quickstart
==========

If you have a working Python3 environment, use pypi to install the latest DHNx version:

.. code:: bash

    pip install dhnx

Install the developer version of DHNx by cloning DHNx to your computer and running

.. code:: bash

    pip install -e 

in your virtualenv.

Check out the
`examples `_ to get started.

Documentation
=============

The documentation (work in progress) can be found here
``_.
To build the docs locally using sphinx-build run the following in a terminal.

.. code:: bash

    sphinx-build docs 

Contributing
============

Everybody is welcome to contribute to the development of DHNx. The `developer
guidelines of oemof `_
are in most parts equally applicable to DHNx.


Citing
======

We use the zenodo project to get a DOI for each version.
`Search zenodo for the right citation of your DHNx version `_.

If you want to refer specifically to the district heating network optimization
part of DHNx, you can also cite
`https://doi.org/10.5278/ijsepm.6248 `_.


License
=======

MIT License

Copyright (c) 2020 oemof developing group

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


.. |badge_coverage| image:: https://coveralls.io/repos/github/oemof-heat/DHNx/badge.svg?branch=dev&service=github
    :target: https://coveralls.io/github/oemof-heat/DHNx?branch=dev
    :alt: Test coverage

.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7844753.svg
   :target: https://doi.org/10.5281/zenodo.7844753

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

        

---

Owner metadata

• Name: oemof community
• Login: oemof
• Email: [email protected]
• Kind: organization
• Description: Open Energy Modelling Framework - A modular open source framework to model energy supply systems
• Website: https://oemof.org
• Location: Germany
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/8503379?v=4
• Repositories: 17
• Last ynced at: 2024-04-16T01:14:39.887Z
• Profile URL: https://github.com/oemof

---

GitHub Events

Total

• Issues event: 6
• Watch event: 2
• Delete event: 4
• Issue comment event: 4
• Push event: 11
• Pull request review event: 2
• Pull request event: 10
• Create event: 5

Last Year

• Issues event: 6
• Watch event: 2
• Delete event: 4
• Issue comment event: 4
• Push event: 11
• Pull request review event: 2
• Pull request event: 10
• Create event: 5

---

Committers metadata

Last synced: 6 days ago

Name	Email	Commits
Johannes Roeder	j****r@u****e	554
jnnr	j****r@r****e	212
jnnr	3****r	165
Marie Gering	m****g@r****e	43
Joris Nettelstroth	j****h@s****e	35
rbv83	9****3	14
uvchik	u****t@p****u	7
oakca	o****a@g****m	4
Patrik Schönfeldt	P****t@d****e	1

Committer domains:

• rl-institut.de: 2
• dlr.de: 1
• posteo.eu: 1
• stw.de: 1
• uni-bremen.de: 1

---

Issue and Pull Request metadata

Last synced: 1 day ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/oemof/DHNx

---

---

---

Dependencies

Score: 6.401917196727185