CLI guide
The Wake CFD CLI executes cases from JSONC configuration files and supports batch runs, parameter sweeps, and HPC operation. Versioning JSONC files with execution commands ensures reproducible runs across workstations, GPU servers, and MPI clusters.
The CLI targets the following workflows:
- Parameter sweeps across Mach numbers, angles of attack, meshes, and numerical settings
- Remote GPU servers and MPI clusters with schedulers such as Slurm
- Unattended automation (CI, regression tests)
- Reproducible analysis records preserving input files, logs, and results
The GUI provides interactive case assembly and mesh inspection. Transition repeated calculations to the CLI for automation.
CLI chapters
Running Wake CFD Solver execution, parallel operation, configuration inheritance, and runtime overrides.
Environment variables Bootstrap configuration for logging, MPI, and runtime diagnostics.
CLI configuration-file reference Complete JSONC key reference for command-line workflows.
Troubleshooting Execution error diagnosis and resolution.
Find a topic
| Task | Start here |
|---|---|
| Execute cases in parallel or on specific GPUs | Running Wake CFD |
| Override configuration without editing base files | Running Wake CFD |
| Reuse settings across multiple cases | Running Wake CFD |
| Adjust logging or MPI behavior | Environment variables |
| Set iteration limits or residual targets | Run control and convergence |
| Look up JSONC key definitions | CLI configuration-file reference |
| Resolve execution errors | Troubleshooting |
CLI scope
The CLI addresses two distinct aspects:
- Execution — Solver binaries, parallel operation, configuration inheritance, runtime overrides, and environment setup
- Case definition — Mesh, analysis mode, physical models, boundary conditions, numerical methods, and outputs
Case definitions are stored in JSON or JSONC files. The Input and configuration reference documents configuration settings; this chapter covers execution.