flow_state

Compressible flow state calculations for Python.

Install

pip install flowstate

Quick Start

API:

from flow_state import solve

# From Mach and altitude
state = solve(mach=2.0, altitude=10000)

# From Mach and stagnation conditions (wind tunnel)
state = solve(mach=6, pres_stag=(140, "psi"), temp_stag=420)

# From Mach and target unit Reynolds number
state = solve(mach=5.3, re1=12.8e6)

print(state)  # Full summary
print(state.pres, state.temp, state.re1)

CLI:

flow-state init    # Create a config template
flow-state solve   # Solve from flow_config.toml
flow-state recover base_flow.hdf5  # Recover flow_conditions.json from HDF5 metadata

• API Usage: https://uahypersonics.github.io/flow-state/user_guide/api_usage/
• CLI Usage: https://uahypersonics.github.io/flow-state/user_guide/cli_usage/

Documentation

Full documentation: https://uahypersonics.github.io/flow-state

Citation

If you use flow_state in your research, please cite it:

@software{flow_state,
  author = {Hader, Christoph},
  title = {flow\_state: Compressible Flow State Calculations},
  url = {https://github.com/uahypersonics/flow-state},
  year = {2026}
}

Code Style

This project follows established Python community conventions so that contributors can focus on the physics rather than inventing formatting rules.

Releasing

This project uses Semantic Versioning (vMAJOR.MINOR.PATCH):

• MAJOR (v1.0.0, v2.0.0): Breaking API changes
• MINOR (v0.3.0, v0.4.0): New features, backward-compatible
• PATCH (v0.3.1, v0.3.2): Bug fixes, minor corrections

To publish a new version to PyPI:

1. Regenerate the API architecture diagram:

   pydeps src/flow_state --noshow --max-bacon=4 --cluster -o docs/assets/architecture.svg
   

2. Commit and push to main
3. Tag and push:

   git tag -a vMAJOR.MINOR.PATCH -m "Release vMAJOR.MINOR.PATCH"
   git push origin vMAJOR.MINOR.PATCH
   

The GitHub Actions workflow will automatically build and publish to PyPI via Trusted Publishing.

License

GNU General Public License v3.0 or later. See LICENSE for the complete license terms.