Setup document shape

Every setup document requires:

Property	Required value
schema_version	Integer 1
kind	baseline or experiment
model.configuration_file_name	Normally model_configuration.yaml
chartpack or chartpacks	Exactly one form

An experiment also requires exactly one of design and designs. The singular design form takes its filename from artefacts.design_file_name.

Standard setup entry point

Keep setup.py small and unchanged across simulations:

from pathlib import Path

from gcubed.experiments import generate_setup_artefacts


if __name__ == "__main__":
    generate_setup_artefacts(Path(__file__))

From the simulation directory, run:

python setup.py

What does not belong in setup

Do not add workflow stages, run options, optimiser or fixed-point settings, results paths, logging settings, overwrite flags or custom Python projection handlers. Those responsibilities remain in maintained run_*.py scripts.

The public key is artefacts, not artifacts.

Member groups and selectors