Metadata-Version: 2.4
Name: cfdvv
Version: 0.5.1
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 .                # editable install (dev)
pip install -e ".[dev]"         # with test dependencies
pip install cfdvv               # from PyPI (all cases included)
```

## Usage

```bash
cfdvv list                                    # List all cases
cfdvv list -c verification -t laminar         # Filter by category and tags

# Case ID works for all commands (no full path needed)
cfdvv info poiseuille-2d                      # Case details
cfdvv compare poiseuille-2d -r my_results.csv # Compare against reference
cfdvv gci poiseuille-2d -r coarse.csv -r medium.csv -r fine.csv
cfdvv report poiseuille-2d -r my_results.csv -o report.html
cfdvv validate poiseuille-2d                  # Validate YAML file
cfdvv example-output poiseuille-2d            # Show expected CSV format

# Full paths also work (backward-compatible)
cfdvv info tools/cfdvv/cases/verification/incompressible/poiseuille-2d
cfdvv compare tools/cfdvv/cases/verification/incompressible/poiseuille-2d -r my_results.csv
cfdvv gci tools/cfdvv/cases/... -r coarse.csv -r medium.csv -r fine.csv
```

## Running tests

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