Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vasulab/rgfrosh
A frozen shock solver for ideal and real gas equations of state.
https://github.com/vasulab/rgfrosh
equation-of-state ideal-gas numpy python real-gas shock-tube
Last synced: about 1 month ago
JSON representation
A frozen shock solver for ideal and real gas equations of state.
- Host: GitHub
- URL: https://github.com/vasulab/rgfrosh
- Owner: VasuLab
- License: mit
- Created: 2021-12-07T18:50:01.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-11T17:07:32.000Z (4 months ago)
- Last Synced: 2024-10-11T16:40:13.935Z (about 1 month ago)
- Topics: equation-of-state, ideal-gas, numpy, python, real-gas, shock-tube
- Language: Python
- Homepage: https://vasulab.github.io/rgfrosh/
- Size: 1.27 MB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# `rgfrosh` (Real Gas FROzen SHock)
[](https://codecov.io/gh/VasuLab/RGFROSH)
[](https://pypi.python.org/pypi/rgfrosh)
[](https://github.com/VasuLab/rgfrosh)
[](https://github.com/psf/black)
[](https://github.com/VasuLab/rgfrosh/blob/main/LICENSE)
[](https://joss.theoj.org/papers/6bb745c8b115f25cee8b6fb251a9a2ff)
[](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].
`rgfrosh` is a package for calculating conditions behind incident and reflected shock in
a shock tube. As its name suggests, `rgfrosh` was written primarily for solving the frozen shock equations for
a real gas equation of state; however, the implementation also allows for the use of the ideal gas equation of state or
even custom equations of state. Additionally, an implementation of the ideal shock equations is also available for comparison.
## Documentation
The [documentation site](https://vasulab.github.io/rgfrosh/latest) provides a detailed
[user guide](https://vasulab.github.io/rgfrosh/latest/guide/getting-started) and
[reference](https://vasulab.github.io/rgfrosh/latest/reference) for the package.
## Installation
`rgfrosh` can be installed using
```
pip install rgfrosh
```
which also installs required dependencies. Cantera or CoolProp are optional and must
be installed separately if desired.
## Contributing
For any bugs or feature requests, create an issue on the
[issue tracker](https://github.com/VasuLab/rgfrosh/issues).
After cloning the repository, the development environment can be set up with
```
pip install -r requirements.txt
```
Before creating a pull request, be sure to lint
```
black .
```
and run the automated tests
```
pytest
```
These checks will be performed automatically for all pull requests along
with test coverage comparisons.
## Cite
To cite `rgfrosh` click Cite this repositoryon the right side of the GitHub repository
page to export the citation for the latest release of `rgfrosh`. It is also encouraged to cite the
original paper[^1] for the frozen shock equations that this work is a derived from.
[^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).