Data

Tools

Indexes

Applications

Experiments

Open Source Science

rgfrosh

rgfrosh: A Python package for calculating shock conditions using real gas equations of state - Published in JOSS (2024)

https://github.com/vasulab/rgfrosh

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 5 DOI reference(s) in README and JOSS metadata
  • ✓
    Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • ✓
    Committers with academic emails
    1 of 1 committers (100.0%) from academic institutions
  • ✓
    Institutional organization owner
    Organization vasulab has institutional domain (mae.ucf.edu)
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

equation-of-state ideal-gas numpy python real-gas shock-tube
Last synced: 6 months ago · JSON representation ·

Repository

A frozen shock solver for ideal and real gas equations of state.

Basic Info
Statistics
  • Stars: 5
  • Watchers: 0
  • Forks: 0
  • Open Issues: 5
  • Releases: 8
Topics
equation-of-state ideal-gas numpy python real-gas shock-tube
Created about 4 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License Citation

README.md

rgfrosh (Real Gas FROzen SHock)

CI codecov pypi versions Code style: black

license status DOI

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 provides a detailed user guide and 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.

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).

Owner

  • Name: Vasu Lab
  • Login: VasuLab
  • Kind: organization
  • Location: United States of America

Center for Advanced Turbomachinery and Energy Research (CATER) at the University of Central Florida.

JOSS Publication

rgfrosh: A Python package for calculating shock conditions using real gas equations of state
Published
July 11, 2024
DOI
Volume 9, Issue 99, Page 6855
Authors
Cory Kinney ORCID
Department of Mechanical and Aerospace Engineering, University of Central Florida, Orlando, FL USA
Subith Vasu
Department of Mechanical and Aerospace Engineering, University of Central Florida, Orlando, FL USA
Editor
Kyle Niemeyer ORCID
Tags
shock tube normal shock frozen shock ideal gas real gas
View PDF Review Thread Software Archive

Citation (CITATION.cff) 

cff-version: "1.2.0"
authors:
- family-names: Kinney
  given-names: Cory
  orcid: "https://orcid.org/0000-0001-8774-3090"
- family-names: Vasu
  given-names: Subith
doi: 10.5281/zenodo.12725333
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Kinney
    given-names: Cory
    orcid: "https://orcid.org/0000-0001-8774-3090"
  - family-names: Vasu
    given-names: Subith
  date-published: 2024-07-11
  doi: 10.21105/joss.06855
  issn: 2475-9066
  issue: 99
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 6855
  title: "rgfrosh: A Python package for calculating shock conditions
    using real gas equations of state"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.06855"
  volume: 9
title: "rgfrosh: A Python package for calculating shock conditions using
  real gas equations of state"

GitHub Events

Total
  • Push event: 1
Last Year
  • Push event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 102
  • Total Committers: 1
  • Avg Commits per committer: 102.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Cory Kinney c****y@u****u 102
Committer Domains (Top 20 + Academic)
ucf.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 15
  • Total pull requests: 3
  • Average time to close issues: 3 months
  • Average time to close pull requests: 2 minutes
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 0.6
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • corykinney (12)
  • cartemic (3)
Pull Request Authors
  • corykinney (3)
Top Labels
Issue Labels
enhancement (6) test (5) bug (2)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 16 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 9
  • Total maintainers: 1
pypi.org: rgfrosh

A frozen shock solver for ideal and real gas equations of state.

  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 16 Last month
Rankings
Dependent packages count: 10.1%
Dependent repos count: 21.6%
Average: 24.4%
Stargazers count: 25.1%
Forks count: 29.8%
Downloads: 35.4%
Maintainers (1)
corykinney
Last synced: 6 months ago

Dependencies

.github/workflows/main.yml actions
  • actions/checkout v2 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite
  • psf/black stable composite
.github/workflows/release.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish 27b31702a0e7fc50959f5ad993c78deac1bdfc29 composite
pyproject.toml pypi
requirements.txt pypi
  • CoolProp *
  • attrs *
  • black *
  • cairosvg *
  • cantera *
  • mike *
  • mkdocs-material *
  • mkdocstrings-python *
  • numpy *
  • pillow *
  • pytest *
  • pytest-cov *
  • tabulate *