README.md

cryowire tutorial

A hands-on tutorial for cryowire — the Python library for dilution refrigerator wiring configuration.

Prerequisites

• Python 3.13+
• uv

Setup

uv sync

Run

uv run python main.py

This will:

1. Define a component catalog (attenuators, filters, amplifiers, isolators)
2. Build a cooldown configuration for an 8-qubit chip
3. Apply per-line overrides (remove filters, swap attenuator values)
4. Print a wiring summary table to the terminal
5. Export YAML files, a Markdown summary, and an SVG wiring diagram to output/

What you'll learn

Topic	Description
Component catalog	Define reusable components (Attenuator, Filter, Amplifier, Isolator)
CooldownBuilder	Fluent API to build wiring configurations by stage
Per-line overrides	Context manager (for_lines) to modify specific lines
Summary	Terminal, Markdown, and HTML summary formats
Diagram	Publication-quality SVG wiring diagrams
Export	YAML files following the cryowire spec