Cryowire Specification¶

Specification for dilution refrigerator wiring configuration data in YAML format.

About This Spec¶

cryowire-spec defines a YAML data format for describing RF/microwave wiring configurations inside dilution refrigerators. It standardizes wiring configuration management so that the cryowire/cli and cryowire/app can work with the data in a consistent way.

Specification Contents¶

Guide¶

Step-by-step explanation of each element of the spec.

Section	Description
Directory Structure	File layout and roles in a data repository
Temperature Stages	The 6 temperature stages from RT to MXC and signal direction
Component Types	Attenuator, filter, isolator, and amplifier definitions
Line Configuration	Control / Readout Send / Readout Return lines and module format
Examples	Complete YAML sample files

Schema Reference¶

Exhaustive field-level definitions for each YAML file.

Section	Target Files
Wiring Schema	`control.yaml` / `readout_send.yaml` / `readout_return.yaml`
Components Schema	`components.yaml`
Metadata Schema	`metadata.yaml`
Chip Schema	`chip.yaml`

Quick Start¶

Data repositories follow this structure:

my-cryo-data/
├── components.yaml              # Component catalog
├── templates/                   # Module templates
│   ├── control_module.yaml
│   ├── readout_send_module.yaml
│   └── readout_return_module.yaml
├── <cryo-name>/
│   └── <YYYY>/                  # Year group
│       ├── cd001/               # Cooldown directory
│       │   ├── metadata.yaml
│       │   ├── chip.yaml
│       │   ├── control.yaml
│       │   ├── readout_send.yaml
│       │   ├── readout_return.yaml
│       │   └── cooldown.yaml    # Resolved bundle
│       └── cd002/
│           └── ...

Use cryowire/template to get started quickly.

See cryowire.github.io for the full project overview.