Welcome to carbatpy's documentation!
====================================

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.

The current focus is on **steady-state** thermodynamic cycle simulation and
evaluation (efficiency, costs, and optimisation). Time-dependent models are planned.

.. toctree::
   :maxdepth: 2
   :caption: Getting started

   readme
   installation
   quickstart

.. toctree::
   :maxdepth: 2
   :caption: User guide

   usage
   fluid_props
   comp
   cycles_coupled
   optimization
   fluid_mixture_search
   defaults

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   autoapi/index   
   
.. toctree::
   :maxdepth: 2
   :caption: Project

   contributing
   third_party_notices
   authors
   history

.. toctree::
   :maxdepth: 2
   :caption: Legacy / archive

   legacy/index

.. toctree::
   :maxdepth: 2
   :caption: Utilities

   utilities

Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`