scaffold

Scaffolding for new experiments and machine-level rig configurations.

Both halves are “get a machine/experiment ready to use” concerns:

• scaffold_experiment() generates a runnable experiment directory.

• mesofield.scaffold.rigs keeps a per-machine store of canonical hardware.yaml files that mesofield init copies into new experiments.

mesofield.scaffold.scaffold_experiment(target, *, name=None, force=False, hardware='blank')

Generate a runnable experiment layout at target. Returns the dir.

hardware selects the hardware.yaml written into the experiment: a Path (copied verbatim from a canonical rig file), "dev" (mock config), or "blank" (fill-out template).

Parameters:

• target (Path)

• name (str | None)

• force (bool)

• hardware (Path | str)

Return type:

Path

mesofield.scaffold.hardware_yaml_template()

A commented real-hardware skeleton that must be filled out before use.

Used both for mesofield init with the blank choice and for mesofield rig new (a fresh canonical rig file to edit).

Return type:

str

mesofield.scaffold.rigs_dir()

Return (creating if needed) the directory holding canonical rig files.

Return type:

Path

mesofield.scaffold.list_rigs()

Return the sorted names of every rig in the store.

Return type:

list[str]

mesofield.scaffold.rig_path(name)

Return the path a rig named name resolves to (.yaml).

Parameters:

name (str)

Return type:

Path

mesofield.scaffold.rig_devices(name)

Return (device_name, device_type) pairs declared by rig name.

Mirrors how HardwareManager reads the YAML: every top-level mapping (other than scalar config keys) is a device, and a cameras: list expands to one entry per camera.

Parameters:

name (str)

Return type:

list[tuple[str, str]]

mesofield.scaffold.add_rig(name, source, *, force=False)

Copy an existing hardware.yaml into the store under name.

The source is parsed with yaml.safe_load() first so a malformed file is rejected before it lands in the store.

Parameters:

• name (str)

• source (Path)

• force (bool)

Return type:

Path

mesofield.scaffold.new_rig(name, *, force=False)

Write a blank fill-out hardware template into the store under name.

Parameters:

• name (str)

• force (bool)

Return type:

Path

mesofield.scaffold.remove_rig(name)

Delete a rig from the store.

Parameters:

name (str)

Return type:

None

Submodules

• experiment
• rigs