=====
Usage
=====

To use carbatpy in a project::

    import carbatpy
    
The name of the results directory is stored in **carbatpy/cb_config.py** in
_RESULTS_DIR.
It is set to the value of environment variable *CARBATPY_RES_DIR*. Also the name
of the directories with the Refprop (NIST) installation are set there. At the
moment carbatpy needs a *Refprop* license!
Finally an environment variable name with the base directory can be used, if you
do not want to use the standard installation, you must set: .*CARBATPY_BASE_DIR*
    
Heat pump example (current workflow)
------------------------------------
The recommended heat pump example for the current ``comp``-based workflow is maintained
as a Jupyter notebook:

.. toctree::
   :maxdepth: 1
   :caption: Jupyter-notebook

   examples/comp_example_heat_pump


Heat pump example (legacy workflow)
-----------------------------------
The heat pump example for the legacy workflow is given as a Jupyter Jupyter-notebook:

.. toctree::
   :maxdepth: 1
   :caption: Jupyter-notebook

   examples/legacy_example_heat_pump