Getting Started

Install for Development

python -m pip install -e ".[dev,docs]"

For a minimal runtime install:

python -m pip install -e .

Run Smoke Tests

python -m pytest -q
python examples/airfoil/run_airfoil_dflow.py --smoke
python examples/superwing/run_superwing_dflow.py --smoke

The smoke examples use lightweight differentiable dummy evaluators so they do not require external CFD solvers or pretrained checkpoints.

Run From YAML

flowdesign generate --config configs/airfoil/dflow.yaml
flowdesign generate --config configs/superwing/dflow.yaml

Build These Docs

mkdocs serve

Then open the local URL printed by MkDocs.

To publish with GitHub Pages:

mkdocs gh-deploy