Tutorials

Overview

1.1 Bird’s eye view of Quantum Metal (Formerly: Qiskit Metal)
1.2 Quick start
1.3 Saving Your Chip Design
1.4 Headless Quick View — using Quantum Metal without the Qt GUI
1.5 Parametric Design: Iterate and Compare
1.6 QComponent Shape Library

Components

Using QComponents

2.01 How to use a QComponent
2.02 How to copy a QComponent

Routing between QComponents

2.11 Routing 101
2.12 Simple Meander
2.13 Hybrid Auto and AStar
2.14 Get them all with MixedRoute

My first full quantum chip design

2.21 Design a 4 qubit full chip
2.22 Design 100 qubits programmatically
2.23 Modify chip options

How do I make my custom QComponent

2.31 Create a QComponent - Basic
2.32 Create a QComponent - Advanced
2.33 Add my QComponent to a reusable python file

Renderers

3.1 Introduction to QRenderers
3.2 Export your design to GDS
3.3 Render your design to Ansys
3.4 How do I make my custom QRenderer?
3.5 Render your design to Gmsh

Analysis

Core - EM and quantization

4.01 Capacitance matrix and LOM analysis
4.02 Eigenmode and EPR analysis
4.03 Impedance, admittance and scattering analysis
4.04 New LOM and Fluxonium Example
4.05 New LOM and Two Coupled Transmon Example
4.05 New LOM and Two Coupled Transmon Example with sequence

Analysis examples

4.11 Analyzing and tuning a transmon qubit
4.12 Analyzing and tuning a resonator
4.13 Analyzing and tuning a transmon qubit with a resonator
4.14 Analyzing a double hanger resonator (S Param)
4.15 CPW Kappa Calculation
4.16 S21 simulation of a resonator
4.17 S21 simulation and fitting of a resonator
4.18 Eigenmode simulation with Ports
4.19 Analyse a Transmon Qubit using ElmerFEM

Parametric sweeps

4.21 Sweeps - Capacitance matrix
4.22 Sweeps - Eigenmode matrix
4.23 Sweeps - Impedance, scattering and admittance (Z S Y) matrices

Hamiltonian models

4.31 Plotting Wavefunctions of the Quantum Harmonic Oscillator (LC Circuit)
4.32 Transmon Analytics: Plotting Eigenvalues as a Function of Offset Charge
4.33 Transmon Analytics
4.34 Modeling transmon qubit Cooper-pair box Hamiltonian in the charge basis
The Cross Resonance (CR) Gate
Circuit Quantum Electrodynamics (cQED) and the Jaynes-Cummings Interaction Model Using the HCPB Class and QuTip

Quick Topics

Josephson Junction QComponent Demo Notebook
Managing pins
Managing variables
Opening the documentation
QComponent - 3-fingers capacitor
QComponent - Interdigitated transmon qubit
Demo Notebook Demonstrating How to Test for Component/CPW Overlap
Click for Video Tutorials

External Workshops

Independently-maintained workshop materials that exercise Quantum Metal end-to-end (layout → simulation → analysis) using open-source EM solvers via SQDMetal.

  • QDW 2025 — tutorials_quantum_device_design (historical, Metal pre-v0.5) — 4 notebooks covering layout, transmon+resonator, qubit-qubit coupling, and an end-to-end project, simulated with Palace via SQDMetal.

  • QDW 2026 — qdw26-workshop-materials (active, near-mainline Metal) — Dockerized re-tooling of the same 4-notebook progression. Shared uv environment, JupyterLab + VS Code attach paths, Brev / cloud-instance support.