Skip to content
main
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

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 either Python 3.6, or 3.7. If you have an existing Conda environment with one of those Python versions, installing ThermoState can be done by

conda install -c bryanwweber thermostate conda-forge::pint

This installs Pint from the conda-forge channel; if you would like to use another channel to install Pint, change the conda-forge to be the name of the channel you prefer. If Pint is already installed in your environment, the conda-forge::pint can be omitted entirely.

If you do not have an environment with Python 3.6 or 3.7, you can create a new environment with

conda create -n thermostate -c bryanwweber thermostate conda-forge::pint

Pip

Alternatively, ThermoState can be installed with pip.

pip install thermostate

From Source

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

git clone https://github.com/bryanwweber/thermostate
cd thermostate
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.

Documentation Status

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.

DOI

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.

Continuous Integration Status

codecovPython package

Anaconda Package Version

Anaconda-Server Badge Version Anaconda-Server Badge Downloads

You can’t perform that action at this time.