oemof-thermal

Thermal energy components for the Open Energy Modeling Framework (oemof).

https://github.com/oemof/oemof-thermal

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 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    1 of 14 committers (7.1%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.2%) to scientific vocabulary

Keywords from Contributors

energy-system modelling-framework brandenburg energy-system-model oemof
Last synced: 10 months ago · JSON representation

Repository

Thermal energy components for the Open Energy Modeling Framework (oemof).

Basic Info
  • Host: GitHub
  • Owner: oemof
  • License: mit
  • Language: Python
  • Default Branch: dev
  • Homepage: https://oemof.org
  • Size: 6.64 MB
Statistics
  • Stars: 32
  • Watchers: 16
  • Forks: 14
  • Open Issues: 19
  • Releases: 10
Created over 10 years ago · Last pushed about 1 year ago
Metadata Files
Readme License

README.rst

|badge_pypi| |badge_travis| |badge_docs| |badge_coverage| |link-latest-doi|

#############
oemof.thermal
#############

This package provides tools to model thermal energy components as an extension of
oemof.solph, e.g. compression heat pumps, concentrating solar plants, thermal
storages and solar thermal collectors.

.. contents::

About
=====

The aim of oemof.thermal is to create a toolbox for building models of
thermal energy systems. Modeling thermal energy systems requires specific preprocessing
and postprocessing steps whose detail exceeds the generic formulation of components in
oemof.solph. Currently, most of the functions collected here are intended to be used
together with oemof.solph. However, in some instances they may be useful independently
of oemof.solph.

oemof.thermal is under active development. Contributions are welcome.

Quickstart
==========

Install oemof.thermal by running

.. code:: bash

    pip install oemof.thermal

in your virtualenv. In your code, you can import modules like e.g.:

.. code:: python

    from oemof.thermal import concentrating_solar_power

Also, have a look at the
`examples `_.

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

Find the documentation at ``_.

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

Everybody is welcome to contribute to the development of oemof.thermal. Find here the `developer
guidelines of oemof `_.

License
=======

MIT License

Copyright (c) 2019 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_pypi| image:: https://badge.fury.io/py/oemof.thermal.svg
    :target: https://badge.fury.io/py/oemof.thermal
    :alt: PyPI version

.. |badge_docs| image:: https://readthedocs.org/projects/oemof-thermal/badge/?version=stable
    :target: https://oemof-thermal.readthedocs.io/en/stable/
    :alt: Documentation status

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

.. |badge_travis| image:: https://travis-ci.org/oemof/oemof.svg?branch=dev
    :target: https://travis-ci.org/oemof/oemof-thermal
    :alt: Build status

.. |link-latest-doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3606385.svg
    :target: https://doi.org/10.5281/zenodo.3606385
    :alt: Zenodo DOI

Owner

  • Name: oemof community
  • Login: oemof
  • Kind: organization
  • Email: contact@oemof.org
  • Location: Germany

Open Energy Modelling Framework - A modular open source framework to model energy supply systems

GitHub Events

Total
  • Create event: 3
  • Issues event: 1
  • Release event: 3
  • Watch event: 2
  • Delete event: 1
  • Issue comment event: 1
  • Push event: 9
  • Pull request review event: 1
  • Pull request review comment event: 1
  • Pull request event: 2
  • Fork event: 4
Last Year
  • Create event: 3
  • Issues event: 1
  • Release event: 3
  • Watch event: 2
  • Delete event: 1
  • Issue comment event: 1
  • Push event: 9
  • Pull request review event: 1
  • Pull request review comment event: 1
  • Pull request event: 2
  • Fork event: 4

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 1,060
  • Total Committers: 14
  • Avg Commits per committer: 75.714
  • Development Distribution Score (DDS): 0.812
Past Year
  • Commits: 42
  • Committers: 1
  • Avg Commits per committer: 42.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
jnnr j****r@r****e 199
caroline.moeller c****r@r****e 198
FranziPl f****r@b****e 196
Marie Gering m****g@r****e 147
Jakob Wolf j****f@b****e 107
jnnr 3****r 92
Patrik Schönfeldt p****k@s****e 80
jakob-wo 4****o 23
felixj9 3****9 9
Sasan Rasti s****i@i****m 3
uwe u****t@p****u 3
Cord Kaldemeyer c****r@f****e 1
Sabine Haas s****s@r****e 1
Stephan Günther g****e@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 82
  • Total pull requests: 106
  • Average time to close issues: 3 months
  • Average time to close pull requests: 17 days
  • Total issue authors: 15
  • Total pull request authors: 9
  • Average comments per issue: 3.3
  • Average comments per pull request: 2.6
  • Merged pull requests: 92
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 7 days
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 1.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • jnnr (29)
  • jakob-wo (15)
  • c-moeller (9)
  • MaGering (8)
  • p-snft (5)
  • FranziPl (4)
  • ckaldemeyer (3)
  • SabineHaas (2)
  • LuixLore (1)
  • DeepFluxion (1)
  • ttjaden (1)
  • simnh (1)
  • uvchik (1)
  • ciaradunks (1)
  • FrancisMe1 (1)
Pull Request Authors
  • jnnr (35)
  • MaGering (21)
  • FranziPl (17)
  • jakob-wo (11)
  • p-snft (11)
  • c-moeller (10)
  • sasanjac (1)
  • Pyosch (1)
  • SabineHaas (1)
Top Labels
Issue Labels
documentation (19) enhancement (11) bug (9) feedback wanted (6) question (4) help wanted (4)
Pull Request Labels
documentation (22) enhancement (15) bug (7) feedback wanted (6) help wanted (2)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 8
proxy.golang.org: github.com/oemof/oemof-thermal
  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 10 months ago

Dependencies

tests/test_requirements.txt pypi
  • flake8 * test
  • pylint * test
docs/requirements.txt pypi
.github/workflows/codeql.yml actions
  • actions/checkout v3 composite
  • github/codeql-action/analyze v2 composite
  • github/codeql-action/autobuild v2 composite
  • github/codeql-action/init v2 composite
.github/workflows/lint.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v5 composite
  • samuelmeuli/lint-action v1 composite
.github/workflows/packaging.yml actions
  • actions/checkout v1 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
.github/workflows/tox_checks.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/setup-python v5 composite
.github/workflows/tox_pytests.yml actions
  • actions/checkout v1 composite
  • actions/setup-python v5 composite
pyproject.toml pypi
  • matplotlib *
  • numpy >= 1.16.5
  • oemof.solph *
  • pandas >= 0.18.0
  • pvlib <= 0.9.0