Getting Started

Table of Contents

• 1. When to Use This Section
• 2. First Simulation Entry
• 3. Recommended Read Order
• 5. Where to Go Next

This index is the recommended onboarding path for new users. It is organized to minimize first-run failure risk: build first, then run a known working case, then inspect outputs.

1. When to Use This Section

Use this section if you are in one of these states:

• first time cloning PICurv,
• returning after dependency/toolchain changes,
• onboarding someone to the repository and needing a deterministic starting path.

2. First Simulation Entry

The canonical first-run page is:

• Tutorial: Your First Simulation (Flat Channel) complete walkthrough with artifact inspection and troubleshooting context.

3. Recommended Read Order

1. Installation Guide
2. Tutorial: Your First Simulation (Flat Channel)
3. Tutorial: Using a File-Based Grid (Bent Channel)
4. Tutorial: A Guide to Visualizing Your Results

4. Outputs and Aggregates

You should be able to:

• build bin/picsolver and bin/postprocessor,
• generate valid runtime control artifacts from YAML inputs,
• execute run --solve --post-process locally,
• inspect VTK outputs in ParaView,
• map first-run failures to corrective actions.

5. Where to Go Next

• Operational run authoring: User Guide
• Troubleshooting catalog: Common Fatal Errors and Fixes
• CI/smoke test contract: Testing, Smoke, and Quality Gates Guide
• Cross-axis map view: Documentation Map