flow_state
Compressible flow state calculations for Python.
Install
pip install flow-state-calculator
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
- 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.
| Convention | What it covers | Reference |
|---|---|---|
| PEP 8 | Code formatting, naming, whitespace | Python standard style guide |
| PEP 257 | Docstring structure (triple-quoted, imperative mood) | Python standard docstring conventions |
| numpydoc | Docstring sections (Parameters, Returns, Attributes) |
NumPy/SciPy docstring standard — the norm for scientific Python |
| Ruff | Automated linting and formatting | Enforces PEP 8 compliance automatically |
| typing / TYPE_CHECKING | Type hints for IDE support and static analysis | Python standard library |
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:
- Regenerate the API architecture diagram:
pydeps src/flow_state --noshow --max-bacon=4 --cluster -o docs/assets/architecture.svg
- Commit and push to
main - 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
BSD-3-Clause. See LICENSE for details.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file flowstate-0.6.0.tar.gz.
File metadata
- Download URL: flowstate-0.6.0.tar.gz
- Upload date:
- Size: 1.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9f695e604366c93efdd7fce4c7622513a8256fe02b18b609ccff076fdb210108
|
|
| MD5 |
5d62c01257cf90b668fa058a464cdc06
|
|
| BLAKE2b-256 |
3686303e22a688dd50af4bef2ec62df981468fcbed1eedd3a841f2887a197344
|
Provenance
The following attestation bundles were made for flowstate-0.6.0.tar.gz:
Publisher:
publish.yml on uahypersonics/flow-state
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
flowstate-0.6.0.tar.gz -
Subject digest:
9f695e604366c93efdd7fce4c7622513a8256fe02b18b609ccff076fdb210108 - Sigstore transparency entry: 2316247081
- Sigstore integration time:
-
Permalink:
uahypersonics/flow-state@19405737f4762ba56168687108e0484126681eed -
Branch / Tag:
refs/tags/v0.6.0 - Owner: https://github.com/uahypersonics
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@19405737f4762ba56168687108e0484126681eed -
Trigger Event:
push
-
Statement type:
File details
Details for the file flowstate-0.6.0-py3-none-any.whl.
File metadata
- Download URL: flowstate-0.6.0-py3-none-any.whl
- Upload date:
- Size: 58.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
96ec8719603ec40a2d53ddd3c7d324e6abd3157014adeae6435135cf4e3105c6
|
|
| MD5 |
8dc7f1d3dcd244ce1936fc6d70029486
|
|
| BLAKE2b-256 |
9cc2a55e91bafceb73a4a06cce6eb904d1856adfd6e295da8c2cf5aabff08af7
|
Provenance
The following attestation bundles were made for flowstate-0.6.0-py3-none-any.whl:
Publisher:
publish.yml on uahypersonics/flow-state
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
flowstate-0.6.0-py3-none-any.whl -
Subject digest:
96ec8719603ec40a2d53ddd3c7d324e6abd3157014adeae6435135cf4e3105c6 - Sigstore transparency entry: 2316247181
- Sigstore integration time:
-
Permalink:
uahypersonics/flow-state@19405737f4762ba56168687108e0484126681eed -
Branch / Tag:
refs/tags/v0.6.0 - Owner: https://github.com/uahypersonics
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@19405737f4762ba56168687108e0484126681eed -
Trigger Event:
push
-
Statement type:
