User Guide

Table of Contents

• 1. Workflow and Orchestration
• 2. Configuration References
• 3. Task Routes
• 4. Practical Recipes and Support
• 5. Repository Orientation
• 6. Competencies You Should Gain

Type HubFor Users authoring runsStatus Routing only - see linked pages for detail

This section is for day-to-day run authoring, execution, and troubleshooting. If Getting Started proves the toolchain works, this section is where production workflow lives.

1. Workflow and Orchestration

• The Conductor Script: picurv: command model and flag contracts.
• Workflow Recipes and Config Cookbook: practical run patterns and modular profile combinations.
• Anatomy of a Simulation: runtime artifact graph and execution stages.
• Run Artifact Lifecycle Contract: operational path from new run to restart, post-only reuse, and batch job generation.
• Storage Management Guide: recurring run/study archival, offload, catalog, and restore workflows.
• Cluster Run Guide (Slurm): Slurm submission path for single runs.
• Sweep and Study Guide: parameter studies and array jobs.

2. Configuration References

• Configuration Reference: Case YAML: physics/domain/grid/BC controls.
• LES Turbulence Closure: what the subgrid models do, how to choose their averaging and limiting, and how to read the coefficient diagnostics.
• Configuration Reference: Solver YAML: numerical strategy and solver tuning.
• Configuration Reference: Monitor YAML: logging/profiling/diagnostics/output cadence.
• Configuration Reference: Postprocessor YAML: analysis tasks and VTK export controls.
• Grid Generator Guide: generators/grid.gen: direct grid.gen usage and grid_gen wrapper semantics.
• Boundary Conditions Guide: detailed BC handler options and validation rules.
• Particle Initialization and Restart Guide: particle seeding/restart behavior by mode.

3. Task Routes

• Example Catalog: every shipped example, what it demonstrates, and what evidence it provides.
• Case Design Guide: building a case from scratch, in the order the decisions constrain each other.
• Troubleshooting by Symptom: symptom-driven diagnosis, cheapest checks first.
• Capability Evidence Matrix: declared evidence sources for every public capability - sources, not verified results.
• Glossary: PICurv terms and renamed spellings.

4. Practical Recipes and Support

• User How-To Guides: goal-driven recipes ("how do I ...").
• Capabilities Summary: feature matrix and support status.
• Common Fatal Errors and Fixes: known failure signatures and fixes.
• Testing and Validation Guide: smoke/quality checks before pushing changes.

5. Repository Orientation

• Repository Navigation and Directory Guides: directory map and linked local guides.
• Changelog: recent behavior/contract changes.
• Documentation Map: categorized index across lifecycle and artifact types.

6. Competencies You Should Gain

After completing this section, you should be able to:

• create or modify a case safely without breaking YAML contract assumptions,
• run local and cluster workflows with reproducible artifacts,
• execute sweeps and interpret study outputs,
• diagnose and fix common runtime/configuration failures quickly.