Skip to content
Thermal energy components for the Open Energy Modeling Framework (oemof).
Python
Branch: dev
Clone or download
MaGering Merge pull request #66 from oemof/fix/docs-sections
Solve bugs / inconsistencies in solar thermal collector documentation
Latest commit c22beeb Feb 16, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Merge pull request #66 from oemof/fix/docs-sections Feb 16, 2020
examples Merge branch 'dev' into features/compr_heatpumps_add_tests Feb 12, 2020
src/oemof/thermal Merge pull request #66 from oemof/fix/docs-sections Feb 16, 2020
tests
.flake8 Make flake8 happy Dec 1, 2019
.gitignore
.pylintrc Changes to merge dev Nov 4, 2019
.travis.yml Let pytest evaluate coverage Feb 11, 2020
LICENSE
README.rst Attempt to fix non-updating badge image Feb 12, 2020
VERSION
setup.cfg Changes to merge dev Nov 4, 2019
setup.py

README.rst

PyPI version Build status Documentation status Test coverage Zenodo 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.

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 rather new and under active development. Contributions are welcome.

Quickstart

Install oemof.thermal by running

pip install oemof.thermal

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

from oemof.thermal import concentrating_solar_power

Also, have a look at the examples.

Documentation

Find the documentation at https://oemof-thermal.readthedocs.io.

Contributing

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

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.

You can’t perform that action at this time.