Skip to content

Commit 42f5fe8

Browse files
committed
Update directory structure documentation to reflect new cooldown organization
1 parent 088c3d0 commit 42f5fe8

2 files changed

Lines changed: 24 additions & 21 deletions

File tree

docs/guide/directory-structure.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,25 @@ my-cryo-data/
1010
│ ├── readout_send_module.yaml # Readout send line module template
1111
│ └── readout_return_module.yaml # Readout return line module template
1212
├── <cryo-name>/
13-
── chip.yaml # Chip information
14-
│ ├── current/ # Working cooldown
15-
│ │ ├── metadata.yaml
16-
│ │ ├── control.yaml
17-
│ │ ├── readout_send.yaml
18-
│ │ ── readout_return.yaml
19-
└── <YYYY-NNN>/ # Snapshot
20-
│ ├── metadata.yaml
21-
── control.yaml
22-
── readout_send.yaml
23-
│ └── readout_return.yaml
13+
── <YYYY>/ # Year group
14+
├── cd001/ # Cooldown directory
15+
│ ├── metadata.yaml
16+
│ ├── chip.yaml
17+
│ ├── components.yaml # Per-cooldown (optional)
18+
── control.yaml
19+
├── readout_send.yaml
20+
├── readout_return.yaml
21+
│ └── cooldown.yaml # Resolved bundle
22+
── cd002/
23+
└── ...
2424
```
2525

2626
## Key Concepts
2727

2828
- **`components.yaml`** **(required)** — Shared component catalog defining all RF/microwave parts used in wiring configurations. All components must be registered here and referenced by key name in wiring files
2929
- **`templates/`** — Module templates that define default stage configurations per line type. Each template file uses the same format as the `modules` section in wiring files, so they can be imported and shared across cooldowns
30-
- **`current/`**The active cooldown configuration being worked on
31-
- **`<YYYY-NNN>/`**Immutable snapshots of past cooldowns (e.g., `2026-001`)
30+
- **`<YYYY>/`**Year group directory (e.g., `2026`)
31+
- **`cdNNN/`**Cooldown directory with auto-incrementing ID (e.g., `cd001`, `cd002`)
3232
- **`chip.yaml`** — Chip metadata (name, number of qubits)
3333
- **`metadata.yaml`** — Cooldown metadata (ID, date, cryo, operator, purpose)
34+
- **`cooldown.yaml`** — Resolved bundle with all modules expanded and components resolved

docs/index.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,16 @@ my-cryo-data/
4444
│ ├── readout_send_module.yaml
4545
│ └── readout_return_module.yaml
4646
├── <cryo-name>/
47-
│ ├── chip.yaml # Chip information
48-
│ ├── current/ # Working cooldown
49-
│ │ ├── metadata.yaml
50-
│ │ ├── control.yaml
51-
│ │ ├── readout_send.yaml
52-
│ │ └── readout_return.yaml
53-
│ └── <YYYY-NNN>/ # Snapshot
54-
│ └── ...
47+
│ └── <YYYY>/ # Year group
48+
│ ├── cd001/ # Cooldown directory
49+
│ │ ├── metadata.yaml
50+
│ │ ├── chip.yaml
51+
│ │ ├── control.yaml
52+
│ │ ├── readout_send.yaml
53+
│ │ ├── readout_return.yaml
54+
│ │ └── cooldown.yaml # Resolved bundle
55+
│ └── cd002/
56+
│ └── ...
5557
```
5658

5759
Use [cryo-wiring/template](https://github.com/cryo-wiring/template) to get started quickly.

0 commit comments

Comments
 (0)