Metadata-Version: 2.4
Name: cfdvv
Version: 0.4.0
Summary: CFD Verification & Validation Suite: open-source test cases and CLI tools for CFD code verification and validation.
Author-email: Valeria Puzikova <valeria.puzikova@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/vvp-cfd/cfd-vv-suite
Project-URL: Repository, https://github.com/vvp-cfd/cfd-vv-suite
Project-URL: Issues, https://github.com/vvp-cfd/cfd-vv-suite/issues
Keywords: cfd,verification,validation,computational-fluid-dynamics,navier-stokes,benchmark
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Mathematics
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: numpy>=1.21
Requires-Dist: click>=8.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: matplotlib>=3.5; extra == "dev"
Provides-Extra: plot
Requires-Dist: matplotlib>=3.5; extra == "plot"
Provides-Extra: vtk
Requires-Dist: meshio>=5.0; extra == "vtk"
Provides-Extra: openfoam
Requires-Dist: fluidfoam>=0.2; extra == "openfoam"
Provides-Extra: full
Requires-Dist: pytest>=7.0; extra == "full"
Requires-Dist: pytest-cov>=4.0; extra == "full"
Requires-Dist: matplotlib>=3.5; extra == "full"
Requires-Dist: meshio>=5.0; extra == "full"

# cfdvv --- CLI tools for CFD Verification & Validation

## Installation

```bash
pip install -e .                # base install
pip install -e ".[dev]"         # with test dependencies
pip install -e ".[openfoam]"    # with OpenFOAM support
```

## Usage

```bash
cfdvv list                                    # List all cases
cfdvv list -c verification -t laminar         # Filter by category and tags
cfdvv info cases/verification/incompressible/poiseuille-2d  # Case details
cfdvv validate cases/verification/incompressible/poiseuille-2d  # Validate YAML
cfdvv compare cases/verification/incompressible/poiseuille-2d -r my_results.csv
cfdvv gci cases/... -r coarse.csv -r medium.csv -r fine.csv
```

## Running tests

```bash
cd tools
pip install -e ".[dev]"
pytest tests/
```
