carbatpy is a Python package for modelling Carnot batteries (thermal energy storage) based on heat pumps for charging, organic Rankine cycles (ORC) for discharging, and different storage concepts.
Currently, the main focus is on steady-state thermodynamic cycle simulation and evaluation (efficiency, costs, and optimisation). Time-dependent models are planned.
Documentation
Requirements (mandatory)
REFPROP is strongly recommended for meaningful use of the package.
REFPROP (NIST): a valid license is required.
Python: >= 3.10, <3.14
In addition, typical scientific Python packages are used (NumPy, SciPy, pandas, …); see pyproject.toml for the full list.
Optional components
carbatpy can optionally interface with additional tools. These are not required to install or import carbatpy. When available, they can be selected explicitly in various functions (they are not enabled automatically).
TREND
If TREND is installed and you want to use it for thermodynamic properties, enable it in carbatpy.cb_config.py by setting the dictionary TREND accordingly (example):
{"USE_TREND": True, "TREND_DLL": "...", "TREND_PATH": "..."}
In addition, the relevant TREND paths typically need to be available as system environment variables (see documentation for details). TREND was developed and is authored by Prof. Roland Span and his co-workers (Chair of Thermodynamics, Ruhr University Bochum).
Note: currently, TREND support is limited to thermodynamic properties (no transport properties).
License note: TREND is licensed under GPLv3+. TREND is not distributed with carbatpy; it must be installed separately. Users are responsible for complying with the TREND license.
Machine models (SPP 2403)
carbatpy can optionally interface with detailed machine-model packages that are developed and maintained in separate repositories and may have their own license and citation requirements. carbatpy itself remains usable without them.
Available add-ons (examples)
spp_machines (turbomachinery/compressor design tools) Authors: Steffen Folkers, Matthias Heselmann, Dieter Brillert, Andreas Brümmer, Sebastian Schuster. Availability: internal/private repository (on request) License: see repository
incept-processmaps (inverse design process maps for compressors) Authors: Matthias Heselmann, Steffen Folkers, … DOI: https://doi.org/10.17877/TUDODATA-2025-MFV1200A License: MIT with attribution requirement (see repository / CITATION)
expander-liege (semi-empirical scroll expander model, Liège) Authors: Elise Neven (University of Liège), Basile Chaudoir (University of Liège), Vincent Lemort. Adaptation/packaging for carbatpy: Philipp Dreis (University of Duisburg-Essen) Upstream: LaboThapPy community (https://github.com/PyLaboThap/LaboThapPy/tree/main) License: Apache-2.0 (upstream); see the add-on repository for details
Installation (internal users)
If you have access to the private repositories, you can install the add-ons via Poetry groups:
all machine add-ons: poetry install --with machines
only selected add-ons: poetry install --with processmaps (etc.)
If Git access is not available, internal wheels can be provided as an alternative.
External users
External users can install base carbatpy normally and request the machine-model add-ons from the respective authors/maintainers.
Package structure
The main functionality is implemented in the subpackages under carbatpy.models:
cb_fluids: Fluid mixture properties (REFPROP; optional: TREND for thermodynamic data)
components: Models of individual devices such as compressors, turbines, heat exchangers, throttles, etc.
coupled: Coupled component models forming thermodynamic cycles and Carnot batteries
Features
Steady-state calculation of heat pumps, ORCs, and Carnot batteries
Optimisation of pressure levels and working fluid mixture composition for improved second-law efficiency
Cost estimation based on correlations from the literature
Reading cycle configurations and parameters from YAML input files
Quasi steady-state evaluation of efficiencies and costs
Roadmap / TODO
Time-dependent (dynamic) cycle simulation
Further validation and extended component models
Credits
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
Contact
Burak Atakan, University of Duisburg-Essen, Germany
atakan.thermodynamik.duisburg [at] gmail.com
License
MIT License
Third-party notices
carbatpy can interface with optional third-party add-ons which may have their own license and citation requirements. See THIRD_PARTY_NOTICES.rst.
1 maintainer
Metadata
1 maintainer
Release files for carbatpy 0.6.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| carbatpy-0.6.2.tar.gz | 3.2 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| carbatpy-0.6.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 6.4 MB
Release files / carbatpy-0.6.2.tar.gz
| Download URL | carbatpy-0.6.2.tar.gz |
|---|---|
| Size | 3.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
39a38fe7ac1bc124c32d3e64e5a3928437a4d8be4d3fb7dd86aaaf0d6f984b71
|
|
BLAKE2b-256 checksum How to use checksums |
4e7e4d58db35b9dcd70e2c4eff73e66f37029b1d9bf6c2eeae2232e00ac29343
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.0.0 CPython/3.12.10 Windows/11
|
Release files / carbatpy-0.6.2-py3-none-any.whl
| Download URL | carbatpy-0.6.2-py3-none-any.whl |
|---|---|
| Size | 3.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
237bd60b6e6dc29a3575edc0fa7277e4489202fada5c0d706a37c57bb7b810f8
|
|
BLAKE2b-256 checksum How to use checksums |
9496e6831de2082ac2a63a06c10725a900fdd008891ba16b1e5fa09bdfcda9cf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.0.0 CPython/3.12.10 Windows/11
|
