Metadata-Version: 2.1
Name: rgfrosh
Version: 0.1.3
Summary: Frozen shock equations solver.
Home-page: https://github.com/VasuLab/PyRGFROSH
Author: Cory Kinney
Author-email: corykinney@knights.ucf.edu
License: MIT
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
License-File: LICENSE

# Python Real Gas FROzen SHock (PyRGFROSH) Solver

[![DOI](https://zenodo.org/badge/435992350.svg)](https://zenodo.org/badge/latestdoi/435992350)

> This project is a solver for the frozen shock equations[^1] developed in Python at the
> University of Central Florida. The original RGFROSH was developed in FORTRAN at Stanford 
> University by D. F. Davidson and R. K. Hanson using real gas subroutines for 
> CHEMKIN[^2][^3]. 

PyRGFROSH is a Python package (`rgfrosh`) for calculating conditions behind incident and reflected shock in
a shock tube for an arbitrary equation of state. PyRGFROSH requires a thermodynamic interface 
for calculating mixture properties as a function of temperature and pressure and currently supports:

- [Cantera](https://github.com/cantera/cantera)
- [CoolProp](https://github.com/CoolProp/CoolProp) (see [example](https://vasulab.github.io/PyRGFROSH/guide/#coolprop-example)) 
- [User-defined interfaces](https://vasulab.github.io/PyRGFROSH/guide/#user-defined-interfaces)

## Documentation

The [documentation](https://vasulab.github.io/PyRGFROSH) provides a detailed 
[user guide](https://vasulab.github.io/PyRGFROSH/guide) and 
[API reference](https://vasulab.github.io/PyRGFROSH/reference) for the package.

## Installation

PyRGFROSH can be installed using

```
pip install rgfrosh
```

which also installs required dependencies.

[^1]: Davidson, D.F. and Hanson, R.K. (1996), Real Gas Corrections in Shock Tube Studies 
at High Pressures. Isr. J. Chem., 36: 321-326. https://doi.org/10.1002/ijch.199600044
[^2]: P. Barry Butler, "Real Gas Equations of State for Chemkin" Sandia Report No. 
SAND88-3188 (1988). https://doi.org/10.2172/6224858
[^3]: R. G. Schmitt, P. B. Butler, N. B. French "Chemkin real gas: a Fortran package for 
analaysis of thermodynamic properties and chemical kinetics in non-ideal systems," 
U. of Iowa Report UIME PPB 93-006 (1994).
