Skip to content

Commit

Permalink
Merge branch 'docs/#570-update-package-description' into dev
Browse files Browse the repository at this point in the history
  • Loading branch information
fwitte committed Nov 10, 2024
2 parents 3d2b5db + c238a28 commit c2ceb0b
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 16 deletions.
18 changes: 10 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
Thermal Engineering Systems in Python
=====================================
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 Modelling Framework `oemof <https://oemof.org/>`_
and can be used as a standalone package.
powerful simulation toolkit for thermal engineering plants such as various
types of power plants (including organic rankine cycles), heat pumps or
refrigeration machines. Due to its flexibility it is actually possible to
model any kind of thermal energy conversion process, this also includes energy
balancing of industrial processes, district heating or HVAC systems. It is
part of the Open Energy Modelling Framework `oemof <https://oemof.org/>`_ and
can be used as a standalone package.

.. figure:: https://raw.githubusercontent.com/oemof/tespy/9915f013c40fe418947a6e4c1fd0cd0eba45893c/docs/api/_images/logo_tespy_big.svg
:align: center
Expand All @@ -28,10 +31,9 @@ Key Features
============
* **Open** Source
* **Generic** thermal engineering applications
* **Automatic** model documentation in LaTeX for high transparency and
reproducibility
* **Extendable** framework for the implementation of custom components and
component groups
* **Extendable** framework for the implementation of custom components, fluid
property formulations and equations
* **Integration** of optimization capabilities through an API to pygmo
* **Postprocessing** features like exergy analysis and fluid property plotting

.. start-badges
Expand Down
18 changes: 10 additions & 8 deletions docs/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@ Thermal Engineering Systems in Python
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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 Modeling Framework `oemof <https://oemof.org/>`_
and can be used as a standalone package.
powerful simulation toolkit for thermal engineering plants such as various
types of power plants (including organic rankine cycles), heat pumps or
refrigeration machines. Due to its flexibility it is actually possible to
model any kind of thermal energy conversion process, this also includes energy
balancing of industrial processes, district heating or HVAC systems. It is
part of the Open Energy Modelling Framework `oemof <https://oemof.org/>`_ and
can be used as a standalone package.

.. image:: /_static/images/logo_tespy_big.svg
:align: center
Expand Down Expand Up @@ -36,10 +39,9 @@ Key Features
============
* **Open** Source
* **Generic** thermal engineering applications
* **Automatic** model documentation in LaTeX for high transparency and
reproducibility
* **Extendable** framework for the implementation of custom components and
component groups
* **Extendable** framework for the implementation of custom components, fluid
property formulations and equations
* **Integration** of optimization capabilities through an API to pygmo
* **Postprocessing** features like exergy analysis and fluid property plotting

Quick installation
Expand Down

0 comments on commit c2ceb0b

Please sign in to comment.