=====
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*
    
You may want to check the test files and the files in the carbatpy/models folder
and in the **carbatpy/utils** folder (e.g. **run_heat_pump_simple.py**
or **run_carnot_battery.py**).