Learn

The tutorial course, in four parts. Each part lists its notebooks in the order to read them. New here? Start with the Quick start page, then Part 1, or pick a goal on Choose your path. Looking for one task? See How do I…?.

Part 1: First steps

Place a component, build a four-qubit chip, save it, iterate on it. All notebooks.

Part 2: From components to chip

QComponents, routing, a full chip, design rules, and your own QComponent. All notebooks.

Part 3: Render and export

Export to GDS, mesh with gmsh, render to Ansys, write a renderer. All notebooks.

Part 4: Simulate and analyze

Open-source and Ansys simulation, then circuits to Hamiltonians. See Simulation pathways for what each solver computes. All notebooks.

Videos and education

Talks, lectures and community walkthroughs. The legacy Qiskit Metal playlist targets an older version, but much of it still teaches the fundamentals.

Legacy video playlist (YouTube)

Recorded a walkthrough with Metal? Open a PR and add your link to this page.

Further reading and references
  • A Review of Design Concerns in Superconducting Quantum Circuits (Levenson-Falk, Shanto, 2024)

  • Eriksson et al., QDesignOptimizer based on ANMod: an automated, physics-guided, multi-parameter design optimizer for superconducting quantum devices, Quantum Sci. Technol. 11, 035024 (2026)

  • Minev et al., Energy-participation (EPR) quantization (see arXiv:2010.00620, and pyEPR docs)

  • Minev et al., Lumped Oscillator Model (LOM) quantization (see docs and Qiskit Metal papers)

  • Kjaergaard et al., Superconducting Qubits: Current State of Play, Annu. Rev. Cond. Matt. Phys. 11, 369 (2020).

  • Clarke and Wilhelm, Superconducting quantum bits, Nature 453, 1031 (2008).

  • Devoret and Schoelkopf, Superconducting Circuits for Quantum Information: An Outlook, Science 339, 1169 (2013).

  • Wendin, Quantum information processing with superconducting circuits: A review, Rep. Prog. Phys. 80, 106001 (2017).

  • Krantz et al., A quantum engineer’s guide to superconducting qubits, Appl. Phys. Rev. 6, 021318 (2019).

  • Kwon et al., Gate-based superconducting quantum computing, J. Appl. Phys. 129, 041102 (2021).

  • Blais et al., Circuit quantum electrodynamics, Rev. Mod. Phys. 93, 025005 (2021).

  • Gao et al., Practical Guide for Building Superconducting Quantum Devices, PRX Quantum 2, 040202 (2021).

Historical office-hours & tutorial recording log (2021–2023)

Dated recordings from the original Qiskit Metal team’s live tutorial and Q&A series. Superseded as a going concern (the series is not ongoing), but many of the individual recordings are still useful references.

Date

Type

Topic

April 1

Tutorial

Introduction to Qiskit Metal

April 8

Tutorial

Overview: Qubit chip design-flow, Part 1

April 15

Tutorial

Overview: Qubit chip design-flow, Part 2

April 22

Forum

First impressions — Qiskit Metal team answers questions and invites feedback.

April 29

Tutorial

QComponents: how to use, modify, and extend the Qiskit Metal library.

May 6

Forum

Q&A — customizing Qiskit Metal designs.

May 6

Offline recordings

Analysis methods: Capacitance and frequency control, Eigenmode & Energy Participation Ratio, Energy Participation Ratio Theory, EPR Quantization with Code Example, Finish Eigenmode + Impedance Analysis, Impedance Analysis Example

May 13

Tutorial

Quantum Analysis 101

May 20

Tutorial

Introduction to the Transmon Qubit

May 27

Tutorial

Physics of the Cooper Pair Box Transmon

June 3

Tutorial

Parametric Sweeps, Github Contribution How-to

July 15

Tutorial

Energy Participation Ratio in Qiskit Metal, New Feature: LOM Analysis for Composite Systems, New Feature: Export Design to Script

Sept 23

Tutorial

Making a QComponent from Scratch

Oct 7

Tutorial

New LOM Analysis Methodology — Part 1

Oct 21

Tutorial

New LOM Analysis Methodology — Part 2

Nov 4

Tutorial

New LOM Analysis Methodology — Part 3

Nov 18

Forum

Q&A — ask anything to the Qiskit Metal team.

Jan 13, 2022

Forum

Q&A — open discussion with the Qiskit Metal team.

Jan 27, 2022

Forum

Helping users generate a custom component.

Feb 10, 2022

Tutorial

GUI Icons, Jaynes-Cummings Model, Template Options, Default Options

Feb 24, 2022

Tutorial

Flip Chip, by guest speaker Sandoko Kosen

Mar 10, 2022

Forum

Metal community feedback session.

Mar 24, 2022

Tutorial

Time Evolution for the CR Gate

Aug 4, 2022

Tutorial

Open-Source Rendering and Simulation Solution for Qiskit Metal

Aug 11, 2022

Tutorial

Qiskit Metal E21: Quantum Spice Web App — Sneak Peak

Feb 2, 2023

Tutorial

Qiskit Metal E22: Open-Source Simulation Renderers — Gmsh & ElmerFEM

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.