Build Process Runs

Instantiate a process template, assign resources to slots, and record parameter values.

Process runs instantiate a process template, assign resources to its slots, and record step parameters for one execution.

Define slots and steps

from recap import Direction

with namespace.build_process_template("Measure Sample", "1.0") as template:
    template.add_resource_slot("sample", "sample", Direction.input)
    template.add_resource_slot("result", "file", Direction.output)
    (
        template.add_step("Measure")
        .add_parameters({
            "acquisition": [
                {"name": "exposure", "type": "float", "default": 1.0},
                {"name": "mode", "type": "str", "default": "standard"},
            ]
        })
        .bind_slot("source", "sample")
        .bind_slot("destination", "result")
        .close_step()
    )

Slots declare compatible resource types. Role bindings let a step refer to a slot by purpose instead of by a concrete resource name.

Create and assign a run

with namespace.build_process_run(
    name="Run 001",
    description="Sample measurement",
    template_name="Measure Sample",
    version="1.0",
) as run:
    run.assign_resource("sample", sample_resource)
    run.assign_resource("result", result_resource)

The resulting ProcessRun records the template, assignments, ordered steps, and parameter values. Use process_run_id= when updating a known run to avoid a name-based lookup.

Record dynamic resources

When an experiment discovers resource structure at runtime, add child resources through a resource builder. Process-run builders can add named runtime children beneath template-generated steps. Children reuse the parent’s step template, start with template defaults, and inherit run resources by role. See Add Runtime Children for creation and nested access.

Set generated process parameters

Generated parameter models provide typed access to values declared by a process step. Read model, mutate it, then submit it back to run:

with namespace.build_process_run(process_run_id=run.id) as builder:
    params = builder.get_params("Measure")
    params.acquisition.exposure = 2.5
    params.acquisition.mode = "fast"
    builder.set_params(params)

set_params() flushes updated values as part of builder transaction.

Finalize a completed run

Finalize is separate lifecycle action. Call it after assignments, steps, and parameters are complete:

with namespace.build_process_run(process_run_id=run.id) as builder:
    builder.finalize()

Finalization marks run active.

Archive a run

Archive completed runs separately when they should remain queryable but no longer be treated as active:

with namespace.build_process_run(process_run_id=run.id) as builder:
    builder.archive()