Science Score: 59.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 7 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
1 of 9 committers (11.1%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (17.1%) to scientific vocabulary
Keywords from Contributors
energy-system
modelling-framework
Last synced: 10 months ago
·
JSON representation
Repository
District heating system optimisation and simulation models
Basic Info
Statistics
- Stars: 36
- Watchers: 12
- Forks: 14
- Open Issues: 37
- Releases: 3
Created about 7 years ago
· Last pushed 11 months ago
Metadata Files
Readme
License
Authors
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
`
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
- Name: oemof community
- Login: oemof
- Kind: organization
- Email: contact@oemof.org
- Location: Germany
- Website: https://oemof.org
- Repositories: 17
- Profile: https://github.com/oemof
Open Energy Modelling Framework - A modular open source framework to model energy supply systems
GitHub Events
Total
- Issues event: 7
- Watch event: 5
- Delete event: 5
- Issue comment event: 4
- Push event: 14
- Pull request review event: 2
- Pull request event: 13
- Fork event: 2
- Create event: 8
Last Year
- Issues event: 7
- Watch event: 5
- Delete event: 5
- Issue comment event: 4
- Push event: 14
- Pull request review event: 2
- Pull request event: 13
- Fork event: 2
- Create event: 8
Committers
Last synced: 11 months ago
Top Committers
| Name | 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 |
| Patrik Schönfeldt | p****k@s****e | 7 |
| oakca | o****a@g****m | 4 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 73
- Total pull requests: 78
- Average time to close issues: 4 months
- Average time to close pull requests: about 2 months
- Total issue authors: 16
- Total pull request authors: 8
- Average comments per issue: 1.66
- Average comments per pull request: 1.33
- Merged pull requests: 63
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 5
- Pull requests: 14
- Average time to close issues: 2 days
- Average time to close pull requests: 12 days
- Issue authors: 3
- Pull request authors: 2
- Average comments per issue: 0.8
- Average comments per pull request: 0.21
- Merged pull requests: 10
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- jnnr (24)
- joroeder (19)
- jnettels (12)
- gitfeldhase (3)
- jakob-wo (2)
- phuismann (2)
- ddceruti (1)
- okocak95 (1)
- frozznight (1)
- BishalMan (1)
- 973xx (1)
- anischakow (1)
- leannejdong (1)
- fgunyel (1)
- Afraz85 (1)
Pull Request Authors
- joroeder (28)
- jnnr (23)
- jnettels (15)
- p-snft (7)
- oakca (2)
- JohannesNitsch (2)
- rbv83 (2)
- MaGering (1)
Top Labels
Issue Labels
enhancement (6)
code improvement (3)
bug (3)
documentation (2)
optimisation (2)
question (1)
Pull Request Labels
bug (4)
enhancement (4)
documentation (4)
Packages
- Total packages: 2
- Total downloads: unknown
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 6
proxy.golang.org: github.com/oemof/DHNx
- Documentation: https://pkg.go.dev/github.com/oemof/DHNx#section-documentation
- License: mit
-
Latest release: v0.0.3
published about 3 years ago
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced:
10 months ago
proxy.golang.org: github.com/oemof/dhnx
- Documentation: https://pkg.go.dev/github.com/oemof/dhnx#section-documentation
- License: mit
-
Latest release: v0.0.3
published about 3 years ago
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced:
10 months ago
Dependencies
docs/requirements.txt
pypi
- sphinx >=1.3
- sphinx-rtd-theme *
setup.py
pypi
- addict *
- folium *
- matplotlib *
- networkx *
- oemof.solph *
- pandas *
- pillow *
- scipy *
tests/test_requirements.txt
pypi
- flake8 * test
- geopandas * test
- pylint * test
- pytest * test
- shapely * test
.github/workflows/lint.yml
actions
- actions/checkout v2 composite
- actions/setup-python v1 composite
- samuelmeuli/lint-action v1 composite
.github/workflows/packaging.yml
actions
- actions/checkout v1 composite
- actions/setup-python v2 composite
- actions/upload-artifact v2 composite
.github/workflows/tox_checks.yml
actions
- actions/cache v2 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
.github/workflows/tox_pytests.yml
actions
- actions/checkout v1 composite
- actions/setup-python v2 composite