ThermoState

This package provides a wrapper around CoolProp that integrates Pint for easy thermodynamic state management in any unit system.

Installation

Conda

The preferred installation method is to use conda. Using Conda, ThermoState can be installed for Python 3.9 and up. You can create a new environment with:

conda create -n thermostate -c conda-forge thermostate

Pip

Alternatively, ThermoState can be installed with pip.

python -m pip install thermostate

From Source

ThermoState is a pure-Python package that supports any Python version 3.9 and higher. To install from source, clone the source code repository and install using pip.

git clone https://github.com/bryanwweber/thermostate
cd thermostate
python -m pip install .

Documentation

Documentation can be found at https://thermostate.readthedocs.io/. The documentation contains a short tutorial, examples, and API documentation for the package.

Citation

If you have used ThermoState in your work, we would appreciate including a citation to the software! ThermoState has been published in JOSE, available at the link below.

For those using Bib(La)TeX, you can use the following entry

@article{weber_thermostate_2018,
    title = {{ThermoState}: {A} state manager for thermodynamics courses},
    volume = {1},
    issn = {2577-3569},
    shorttitle = {{ThermoState}},
    url = {https://jose.theoj.org/papers/10.21105/jose.00033},
    doi = {10.21105/jose.00033},
    number = {8},
    urldate = {2018-10-24},
    journal = {Journal of Open Source Education},
    author = {Weber, Bryan},
    month = oct,
    year = {2018},
    pages = {33}
}

Code of Conduct & Contributing

We welcome contributions from anyone in the community. Please look at the Contributing instructions for more information. This project follows the Contributor Covenant Code of Conduct, version 1.4. In short, be excellent to each other.

bryanwweber / thermostate

readme