simtools-create-setting-workflow

Prepare a simple parameter-setting workflow and optionally run it.

Prepare a simple model-parameter setting from a value, version, instrument, and scientific description. Run from the parameter-setting repository, or select its root with --output_path.

For parameters with multiple typed values, pass a bracketed list and include units for unitful values. For example:

simtools-create-setting-workflow \
  --instrument LSFN-design --parameter flasher_pulse_shape \
  --value '["Gauss-Exponential", "0.4 ns", "1.59 ns"]' \
  --parameter_version 1.0.1 \
  --description "Set pulse shape, width, and decay time"

simtools-create-setting-workflow \
  --instrument LSTN-design --parameter min_photons \
  --value 121 --parameter_version 2.0.1 \
  --description "Updated photon threshold" --run

The command creates input/INSTRUMENT/PARAMETER/ACTIVITY/config.yml and input.meta.yml. It generates IDs, timestamps, contact defaults, and an unambiguous site automatically. Use --site for instruments shared between sites and --source_url for a reference. The source reference is included in the scientific description and output metadata. Select a model repository with the usual --simulation_models_path or Git-source options.

Without --run, only the inputs are prepared. With it, the existing workflow runner writes the parameter JSON and metadata under output/INSTRUMENT/PARAMETER/ACTIVITY/. Identical inputs reuse their workflow; conflicting values, descriptions, contacts, or runtime definitions require a new parameter version. Retrying a prepared workflow uses the same activity output directory. No additional execution or provenance directories are created.

An optional --runtime_environment_file runtime.yml copies the validated runtime definition into the new workflow as runtime.yml, without starting a container during preparation. When --run is used, the generated runtime file is selected automatically. Use an image digest for OCI images and ensure paths in the definition are available from the repository root. File and structured parameters use the existing derivation/submission applications.

Command line arguments

options

–help

show this help message and exit

–instrument

Instrument whose parameter is being set.

Required.

–parameter

Model parameter name.

Required.

–parameter_version

New parameter version.

Required.

–value

Value or list of values, optionally with units.

Required.

–description

Scientific reason or source.

Required.

–site

Site; inferred for instruments with an unambiguous site.

–source_url

Reference describing the parameter setting.

–model_parameter_schema_version

Parameter schema version (default: latest).

–workflow_runtime_file

Runtime YAML to embed in the generated workflow.

–run

Run the prepared workflow.

model repository

–simulation_models_path

Path containing the simulation-model repository to read.

–simulation_models_git_path

Path to a local normal, bare, or mirror Git repository containing simulation models.

–simulation_models_git_revision

Git tag, ref, or commit to read from the simulation-model repository.

application

–show_options

Print available values for a supported option and exit.