Start at the top-level README for what bouquet is, how to install it, and a working quickstart. These pages carry the depth.
| Page | Contents |
|---|---|
| workflows.md | The pipeline stage by stage, what is perturbed vs. held fixed, the full configuration reference, workflow presets, archive reading, export, timeseries sweeps, process-parallel generation |
| physics-notes.md | What the ensemble is (and isn’t), the σ=0 consistency guard, bootstrap treatment and jbs_delta_mode, PCHIP kinetics regridding, edge classification, IDA-hybrid kinetics, Z_eff-primary densities, corrective j_phi |
| coil-constraints.md | Coil classes, the VSC channel drift metric, progressive homotopy, the in_spec criterion and per-draw attributes |
| io-and-plotting.md | GEQDSK / p-file / IDA / IMAS readers and writers, COCOS conversion, the plotting catalogue |
| api-reference.md | Every public name, grouped by role |
| archive-schema.md | The HDF5 archive layout (schema v2) |
| gui-display-guide.md | In-notebook plotting vs. the plot-family CLI |
| Page | Contents |
|---|---|
| ../architecture.md | Physics assumptions, numerical approximations, coordinate/sign conventions, tolerance budgets, known limitations |
| flowchart/ | The rendered physics workflow and the 550-node interactive logic map (view) |
| CI.md | Fast vs. solver test tiers, the manual pre-merge gate, branch protection |
| CHANGES_SUMMARY.md | Historical change summaries by development round |
| ISSUE_jphi_edge_reconstruction.md | Open issue: jphi-linterp edge/separatrix handling and the σ=0 boundary floor |
| proposals/ | Design proposals |
Runnable notebooks on synthetic, non-proprietary D3D-like fixtures are in
../examples/.