QLibrary (qiskit_metal.qlibrary)#

Module containing all Qiskit Metal QLibrary.

Core Classes#

QComponent(design[, name, options, make, ...])

QComponent is the core class for all Metal components and is the central construct from which all components in Metal are derived.

ParsedDynamicAttributes_Component(component)

Provides a parsing view of the component options.

BaseQubit(design[, name, options, ...])

Qubit base class.

QRoute(design[, name, options, type])

Super-class implementing routing methods that are valid irrespective of the number of pins (>=1).

QRouteLead(*args, **kwargs)

A simple class to define a an array of points with some properties, defines 2D positions and some of the 2D directions (XY plane).

QRoutePoint(position[, direction])

A convenience wrapper class to define an point with orientation, with a 2D position and a 2D direction (XY plane).

Sample Shapes#

CircleCaterpillar(design[, name, options, ...])

A single configurable circle.

CircleRaster(design[, name, options, make, ...])

A single configurable circle.

NGon(design[, name, options, make, ...])

A n-gon polygon.

NSquareSpiral(design[, name, options, make, ...])

A n count square spiral.

Rectangle(design[, name, options, make, ...])

A single configurable square.

RectangleHollow(design[, name, options, ...])

A single configurable square.

Lumped#

Cap3Interdigital(design[, name, options, ...])

Create a three finger planar capacitor with a ground pocket cuttout.

CapNInterdigital(design[, name, options, ...])

Generates a two pin (+) structure comprised of a north CPW transmission line, and a south transmission line, coupled together via a finger capacitor.

ResonatorCoilRect(design[, name, options, ...])

A rectangle spiral resonator based on length input.

Couplers#

CoupledLineTee(design[, name, options, ...])

Generates a three pin (+) structure comprised of a primary two pin CPW transmission line, and a secondary one pin neighboring CPW transmission line that is capacitively/inductively coupled to the primary.

LineTee(design[, name, options, make, ...])

Generates a three pin (+) structure comprised of a primary two pin CPW transmission line, and a secondary one pin neighboring CPW transmission line that is capacitively coupled to the primary.

CapNInterdigitalTee(design[, name, options, ...])

Generates a three pin (+) structure comprised of a primary two pin CPW transmission line, and a secondary one pin neighboring CPW transmission line that is capacitively coupled to the primary.

TunableCoupler01(design[, name, options, ...])

One of the tunable couplers Based off the implementation in https://arxiv.org/pdf/2011.01261.pdf.

TunableCoupler02(design[, name, options, ...])

One of the tunable couplers

Resonator#

ReadoutResFC(design[, name, options, make, ...])

The base ReadoutResFC class

ResonatorLumped(design[, name, options, ...])

The base ResonatorLumped class Inherits the QComponent class

Terminations#

LaunchpadWirebond(design[, name, options, ...])

Launch pad to feed/read signals to/from the chip.

LaunchpadWirebondCoupled(design[, name, ...])

Launch pad to feed/read signals to/from the chip.

LaunchpadWirebondDriven(design[, name, ...])

Launch pad to feed/read signals to/from the chip.

OpenToGround(design[, name, options, make, ...])

A sample_shapes open to ground termination.

ShortToGround(design[, name, options, make, ...])

A sample_shapes short to ground termination.

Transmission Lines#

RouteStraight(design[, name, options, type])

Draw a straight Route connecting two pins.

RouteFramed(design[, name, options, type])

A non-meandered sample_shapes CPW that is auto-generated between 2 components.

RouteMeander(design[, name, options, type])

Implements a simple CPW, with a single meander.

RouteAnchors(design[, name, options, type])

Creates and connects a series of anchors through which the Route passes.

RouteMixed(design[, name, options, type])

Implements fully featured Routing, allowing different type of connections between anchors.

RoutePathfinder(design[, name, options, type])

Non-meandered CPW class that combines A* pathfinding algorithm with simple 1-, 2-, or S-shaped segment checks and user-specified anchor points.

Qubits#

jj_dolan(design[, name, options, make, ...])

The base "JJ_Dolan" inherits the "QComponent" class.

jj_manhattan(design[, name, options, make, ...])

The base "JJ_Manhattan" inherits the "QComponent" class.

TransmonConcentric(design[, name, options, ...])

The base TrasmonConcentric class .

TransmonConcentricType2(design[, name, ...])

The base TrasmonConcentric class Inherits BaseQubit class.

TransmonCross(design[, name, options, ...])

The base TransmonCross class.

TransmonCrossFL(design[, name, options, ...])

The base TransmonCrossFL class.

TransmonInterdigitated(design[, name, ...])

The base "TransmonInterdigitated" inherits the "QComponent" class.

TransmonPocket(design[, name, options, ...])

The base TransmonPocket class.

TransmonPocketCL(design[, name, options, ...])

The base TransmonPocketCL class.

TransmonPocket6(design[, name, options, ...])

Transmon pocket with 6 connection pads.

TransmonPocketTeeth(design[, name, options, ...])

Transmon pocket with 'Teeth' connection pads.

TunableCoupler01(design[, name, options, ...])

One of the tunable couplers Based off the implementation in https://arxiv.org/pdf/2011.01261.pdf.

SQUID_LOOP(design[, name, options, make, ...])

The base "SQUID_LOOP" inherits the "QComponent" class.

StarQubit(design[, name, options, make, ...])

A single configurable circle with multiple pads.

Submodules#

anchored_path

Anchored path.