flow-props 0.1.0

Extract flow properties from CFD data: boundary layer thickness, entropy layer thickness

flow-props

Python tool suite to extract flow properties from CFD data, such as boundary layer thickness and entropy layer thickness.

Install

pip install flow-props

Quick Start

import flow_props

Features

• under construction

Documentation

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

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
   

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

License

BSD-3-Clause. See LICENSE for details.