Thermal Engineering Systems in Python (TESPy)
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc adjusted version number Oct 25, 2018
tespy tidy up docstrings Dec 15, 2018
tutorial moved the examples to the tespy_examples repository at fwitte/tespy_e… Aug 10, 2018
.gitignore fixed doc folder for readthedocs Jan 30, 2018
LICENSE first try for setup.py Jan 26, 2018
README.rst
VERSION adjusted version number Oct 25, 2018
requirements_rtd.py updated requirements for beautiful printouts Aug 28, 2018
setup.cfg first try for setup.py Jan 26, 2018
setup.py adjusted version number Oct 25, 2018

README.rst

TESPy stands for "Thermal Engineering Systems in Python" and provides a powerful simulation toolkit for thermal engineering plants such as power plants, district heating systems or heat pumps. It is an external extension module within the Open Energy System Modeling Framework and can be used as a standalone package.

With the TESPy package you are able to calculate stationary operation in order to design the process of your plant. From that point it is possible to calculate the offdesign behaviour of your plant using underlying characteristics for each of the plants components. For now, the package inlcudes basic components, such as turbines, pumps, compressors, heat exchangers, pipes, mixers and splitters as well as some advanced components (derivatives of heat exchangers, drum).

Everybody is welcome to use and/or develop TESPy. Contribution is already possible on a low level by simply fixing typos in TESPy's documentation or rephrasing sections which are unclear. If you want to support us that way please fork the TESPy repository to your own github account and make changes as described in the github guidelines: https://guides.github.com/activities/hello-world/

Documentation

You can find the full documentation at readthedocs. Use the project site of readthedocs to choose the version of the documentation. Go to the download page to download different versions and formats (pdf, html, epub) of the documentation. Currently, only the dev branch is available.

To get the latest news visit and follow our website.

Installing TESPy

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

pip install tespy

If you want to use the latest features, you might want to install the developer version. See section Developing TESPy for more information. The developer version is not recommended for productive use.

Examples

For a short introduction on how TESPy works and how you can use it, we provide some basic examples and tutorials, go and check them out. You can download the python scripts of all example plants from the tespy_examples repository.

License

Copyright (C) 2018 oemof developing group

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.