Metadata-Version: 2.3
Name: carbatpy
Version: 0.5.0.dev0
Summary: Calculate and optimize Carnot Batteries (Thermal energy storage)
Home-page: https://git.uni-due.de/spp-2403/td-ude/carbatpy
License: MIT
Keywords: thermal-energy-storage, heat-exchanger, thermodynmics,heat transfer
Author: Burak Atakan
Author-email: b.atakan@uni-duisburg.de
Requires-Python: >=3.10
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: SALib (>=1.5.0,<2.0.0)
Requires-Dist: coolprop (>=6.6.0,<7.0.0)
Requires-Dist: ctrefprop (>=0.10.2,<0.11.0)
Requires-Dist: fluids (>=1.0.26,<2.0.0)
Requires-Dist: graphviz (>=0.20.3,<0.21.0)
Requires-Dist: ht (>=1.0.6,<2.0.0)
Requires-Dist: joblib (>=1.4.2,<2.0.0)
Requires-Dist: matplotlib (>=3.9.1,<4.0.0)
Requires-Dist: numpy (>=2.0.0,<3.0.0)
Requires-Dist: pandas (>=2.2.2,<3.0.0)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Requires-Dist: scikit-learn (>=1.5.1,<2.0.0)
Requires-Dist: scipy (>=1.14.0,<2.0.0)
Requires-Dist: seaborn (>=0.13.2,<0.14.0)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Project-URL: Documentation, https://carbatpy-010.readthedocs.io/en/latest/
Project-URL: Repository, https://git.uni-due.de/spp-2403/td-ude/carbatpy
Description-Content-Type: text/x-rst

========
carbatpy
========


.. image:: https://img.shields.io/pypi/v/carbatpy.svg
        :target: https://pypi.python.org/pypi/carbatpy


.. image:: https://readthedocs.org/projects/carbatpy-010/badge/?version=latest
        :target: https://carbatpy-010.readthedocs.io/en/latest/
        :alt: Documentation Status



Modeling Carnot Batteries (Thermal Energy Storage), a Python package.
 

This is a project aiming to model thermal energy storages using heat pumps for 
charging, organic Rankine cycles (ORC) for discharging and different kinds of 
storages.
For this, it is planned to use detailed fluid models (as implemented e.g. in 
REFPROP, CoolProp, or TREND ) and setting up systems which can either be steady 
state or (later) also unsteady. For the moment a **Refprop** license is needed.
Since this project just starts, do not expect too much.

If **Trend** is installed and shall be used,
in the configuration file carbatpy.cb_config.py the dictionary _TREND has to be set from
{"USE_TREND":False, "TREND_DLL":"", 'TREND_PATH':""} to True and the two paths 
must be set as system variables. (The Trend part is only ready for thermodynamic 
data, no transport data!)


It is aimed to have heat exchangers, machines and storages as compounds, which 
can be combined to different charging and dicharging configurations. For these, 
the energy balance, mass balance and further relations will be applied/solved.
Later on also thermo-economic calculations are planned.

For the beginning, the solution of the spatially resolved heat exchanger 
profiles, a  boundary value problem, and its irreversibility will be 
implemented. An optimization will follow. 


Burak Atakan, University of Duisburg-Essen, Germany

You can contact us at: batakan [a t ]uni-duisburg.de or atakan.thermodynamik.duisburg [ a t] gmail.com



* Free software: MIT license
* Documentation: https://carbatpy-010.readthedocs.io/en/latest/


Features
--------
* Can actually calculate steady state heat pumps, ORCs and Carnot-batteries
    with two storage tank pairs. 
* Only thermodynamics (at the moment): no heat exchanger calculations, only
    minimum approach temperatures used.
* Fluid properties from Refprop (NIST)
* Fluid properties from TREND (RU Bochum, Prof. Roland Span) for thermodynamic
    property calculations.


* TODO
    * Include heat exchanger calculations (solvving the ODE with local properties)
    * Optimizing pressure levels for high second law efficiencies.
    * Reading the cycle configuration(s) and parameters from a file.
    

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

