Skip to content

Navigation Menu

Sign in
Sign up

Repository files navigation

cryowire

cryowire/template

A template repository for dilution refrigerator wiring configuration data.

Website

Getting Started

1. Create your data repository

Click the "Use this template" button on GitHub, or use the CLI:

pip install cryowire
cryowire init ./my-data

2. Customize for your lab

Component catalog

Edit components.yaml to define the RF/microwave parts used in your lab:

XMA-10dB:
 type: attenuator
 manufacturer: XMA
 model: XMA-2082-6431-10
 value_dB: 10.0
LNF-HEMT:
 type: amplifier
 manufacturer: LNF
 model: LNF-LNC03_14A
 amplifier_type: HEMT
 gain_dB: 40.0

Module templates

Edit files in templates/ to define your standard wiring modules. These are the default component configurations applied to new cooldowns:

# templates/control_module.yaml
control_standard:
 stages:
 50K:
 - XMA-10dB
 4K:
 - XMA-20dB
 MXC:
 - XMA-20dB

Metadata template

Edit templates/metadata.yaml to set the default metadata template. Placeholders (cdNNN, YYYY-MM-DD, CRYO) are replaced automatically when creating a new cooldown.

3. Remove sample data

Delete the your-cryo/ directory — it exists only as an example:

rm -rf your-cryo/
git add -A && git commit -m "Remove sample data" && git push

4. Connect to cryowire-app

Launch the cryowire-app Web UI with your repository:

# Docker Compose (recommended)
REPO_URL=https://github.com/<your-user>/<your-repo>.git docker compose up
# Or with pip
pip install cryowire-app
cryowire-app --repo https://github.com/<your-user>/<your-repo>.git

Open http://localhost:3000 and start creating cooldowns from the Web UI.

5. (Optional) Use the CLI

pip install cryowire
cryowire new your-cryo --qubits 8
cryowire build your-cryo/2026/cd001/
cryowire validate your-cryo/2026/cd001/

Repository Structure

<your-repo>/
├── .cryowire.yaml # Project configuration
├── components.yaml # Component catalog (master)
├── templates/ # Module templates (customizable)
│ ├── control_module.yaml
│ ├── readout_send_module.yaml
│ ├── readout_return_module.yaml
│ └── metadata.yaml
└── <cryo-name>/ # Cryostat directory
 └── <YYYY>/ # Year group
 ├── cd001/ # First cooldown
 │ ├── metadata.yaml # Cooldown metadata
 │ ├── chip.yaml # Chip information
 │ ├── components.yaml # Component catalog (frozen copy)
 │ ├── control.yaml # Control line wiring
 │ ├── readout_send.yaml
 │ ├── readout_return.yaml
 │ └── cooldown.yaml # Resolved bundle
 └── cd002/ # Second cooldown
 └── ...

About

A template repository for dilution refrigerator wiring configuration data.

Resources

Code of conduct

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

AltStyle によって変換されたページ (->オリジナル) /