How do I…?

Start with one of the sections below, or jump to a task further down.

Devices and papers

Chips designed with Quantum Metal and the papers behind them.

Devices and papers
Reproduced devices

Published chips and results rebuilt as notebooks.

Reproduced devices and results (notebooks)
Learn

The tutorial course in four parts.

Learn
Examples

Designs and components to copy.

Examples

Tasks

Each card names the call or page that does it and links to where it is explained.

Design

Find a component

Browse the catalog: one entry per component with its default options and pins. The desktop GUI Library pane lists the same components.

Place a qubit

Create it on a design: TransmonPocket(design, "Q1", options=dict(pos_x="1mm")).

Route a CPW

Use a route such as RouteMeander or RoutePathfinder between two pins: pin_inputs=dict(start_pin=..., end_pin=...).

Connect to a pin

Every catalog entry lists its pins. Pins carry position, direction and width, and routes attach to them.

Sweep or repeat

Change options in a loop to compare variants, or build many qubits from code.

Check the design rules

from qiskit_metal.validation import validate; validate(design) reports spacing, overlap and connection errors.

Write my own component

Subclass QComponent, give it default options and a make().

Export and view

Export GDS

design.renderers.gds.export_to_gds("chip.gds"). The tutorial covers cheesing (a hole pattern in the ground plane) and the fabrication export.

Open the GDS in KLayout

Load the layer-properties file and the starter rule deck that ship with the docs.

Save and reload a design

Keep a design as a file and load it back in another session.

Simulate

Choose a solver

Ansys, gmsh + ElmerFEM, gmsh + scikit-fem and Palace compared by what each computes and what it needs installed.

Capacitance matrix

Open source with gmsh + ElmerFEM, or Ansys Q3D with the lumped oscillator model.

Eigenmodes and participation

Open source with lumped junctions, or Ansys HFSS with energy-participation analysis.

Get a Hamiltonian

Go from a capacitance matrix or mode participations to qubit parameters.

Use Ansys

Render the design to HFSS or Q3D, then analyze.

Reproduce a published chip

Reproduced devices and results, and layouts of small processors.

Run and automate

Run without the GUI

import qiskit_metal as qm; qm.view(design) draws the chip headlessly.

Script it or drive it from an assistant

The build, check, export loop; a live preview with python -m qiskit_metal.watch; reproducible GDS; using a coding assistant.

Install it

pip install quantum-metal, with extras for the GUI and solvers.