Setup YAML

setup.yaml is an optional authoring file used to generate standard simulation artefacts. It can declare:

• simulation-layer CSV files;
• optimisation-target CSV files;
• one or more design YAML files; and
• one or more chartpack YAML files.

It is not runtime configuration. It does not select solve options, fixed-point settings, result paths or run-script behaviour.

Minimal baseline setup

schema_version: 1
kind: baseline
model:
  configuration_file_name: model_configuration.yaml
chartpack:
  title: Baseline

Minimal experiment setup

schema_version: 1
kind: experiment
model:
  configuration_file_name: model_configuration.yaml
artefacts:
  design_file_name: design.yaml
design:
  name: Policy experiment
  layer_ids: [policy]
maintained_layers:
  - id: policy
    name: Policy layer
    data_file_name: policy.csv
    event_year: 2026
    description: Maintained policy adjustments
chartpack:
  title: Policy experiment

Syntax and recipes

• Document shape
• Member groups and selectors
• Generated simulation layers
• Shock projections
• Maintained simulation layers
• Optimisation targets
• Generate designs
• Generate chartpacks
• Generation, ownership and errors

The packaged setup-configuration-v1.schema.json file defines the grammar. Setup also validates declarations against the selected model before writing anything.

---

Table of contents

• Setup document shape
• Member groups and selectors
• Generated simulation layers
• Shock projections
• Permanent constant shocks
• Temporary constant shocks
• Explicit shock values
• Explicit shocks with a constant tail
• Linear phase-in shocks
• Piecewise-linear shocks
• Combining shock projections
• Maintained simulation layers
• Optimisation targets
• Generate designs
• Generate chartpacks
• Setup generation, ownership and errors