cfd-ops 0.2.0

Operations for transforming, extracting, remapping, and combining CFD datasets built on the cfd-io data model

cfd-ops

Operations for transforming, extracting, remapping, and combining CFD datasets built on the cfd-io data model.

Install

pip install cfd-ops

Documentation

Full documentation: https://uahypersonics.github.io/cfd-ops

Citation

If cfd-ops contributes to published work, please cite via the CITATION.cff in this repository.

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
Google style	Docstring sections (Args, Returns, Raises)	Google Python style guide
Ruff	Automated linting and formatting	Enforces PEP 8 compliance automatically
typing / TYPE_CHECKING	Type hints for IDE support and static analysis	Python standard library

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
   

Use a signed tag when your GPG/SSH signing is configured:

git tag -s 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.