cfd-viz

Lightweight visualization CLI for structured CFD datasets.

Install

pip install cfd-viz

Quick Start

CLI

# display a mesh
cfd-viz mesh grid.su2

# skip every other grid line for dense meshes
cfd-viz mesh grid.su2 --skip 4

# save to file instead of displaying
cfd-viz mesh grid.su2 --skip 2 --output mesh.png

# display a filled contour
cfd-viz contour solution.h5 --field pres

# save contour to file
cfd-viz contour solution.h5 --field pres --output pres.png

Python API

from cfd_io import read_file
from cfd_viz.mesh import plot_mesh
from cfd_viz.contour import plot_contour

ds = read_file("grid.su2")
plot_mesh(ds.grid.x, ds.grid.y, skip=2)

ds = read_file("solution.h5")
plot_contour(ds.grid.x, ds.grid.y, ds.flow["pres"].data, field_name="pres")

Testing

pytest tests/ -q

Code Style

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

Versioning & 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. Commit and push to main
2. 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.