class ReadoutResFC(design: QDesign, name: str = None, options: Dict = None, make=True, component_template: Dict = None)[source]

The base ReadoutResFC class

Inherits the QComponent class

Readout resonator for the flipchip dev. Written for the flipchip tutorial.

The device consists of the following shapes combined together:
  • a circle centered at (‘pos_x’, ‘pos_y’) with a radius of ‘readout_radius’, followed by

  • a straight line (length= ‘readout_l1’) at a 45 degree angle, followed by

  • a 45 degree arc, followed by

  • a vertical line (length = ‘readout_l2’), followed by

  • a 90 degree arc, followed by

  • a horizontal line (length = ‘readout_l3’), followed by

  • a 180 degree arc, followed by

  • a horizontal line (length = ‘readout_l4’), followed by

  • 5 meandering horizontal lines (length = ‘readout_l5’) separated 180 degree arcs.

The arc has a bend radius of ‘readout_cpw_turnradius’,

it is measured from the center of the cpw to the center of rotation.

The lines and arcs will form a cpw with a signal linewidth of ‘readout_cpw_width’, and

signal-to-ground separation of ‘readout_cpw_gap’.

One of the ways to adjust this design to your needs: - change the coupling to the qubit by varying the ‘readout_radius’, - couple the resonator to the feedthrough transmission line via

the horizontal section with this length ‘readout_l3’,

  • adjust the frequency of the resonator by varying ‘readout_l5’.

Create a new Metal component and adds it’s default_options to the design.

  • design (QDesign) – The parent design.

  • name (str) – Name of the component. Auto-named if possible.

  • options (dict) – User options that will override the defaults. Defaults to None.

  • make (bool) – True if the make function should be called at the end of the init. Options be used in the make function to create the geometry. Defaults to True.

  • component_template (dict) – User can overwrite the template options for the component that will be stored in the design, in design.template, and used every time a new component is instantiated. Defaults to None.


ValueError – User supplied design isn’t a QDesign

Note: Information copied from QDesign class.

self._design.overwrite_enabled (bool): When True - If the string name, used for component, already exists in the design, the existing component will be deleted from design, and new component will be generated with the same name and newly generated component_id, and then added to design.

When False - If the string name, used for component, already exists in the design, the existing component will be kept in the design, and current component will not be generated, nor will be added to the design. The variable design.self.status will still be NotBuilt, as opposed to Initialization Successful.

Either True or False - If string name, used for component, is NOT being used in the design, a component will be generated and added to design using the name.




the full module name with the class name.


Component metadata


Default drawing options ??

Return a reference to the parent design object.

The unique id of component within a design.


The Qiskit Metal Logger.

Name of the component.


A dictionary of the component-designer-defined options.


The names of the pins.


Get a list of the names of the element tables.


Dictionary of pins.


Metadata allows a designer to store extra information or analysis results.


Stores the latest status of the component.


ReadoutResFC.add_dependency(parent, child)

Add a dependency between one component and another.

ReadoutResFC.add_pin(name, points, width[, ...])

Adds a pin from two points which are normal/tangent to the intended plane of the pin.

ReadoutResFC.add_qgeometry(kind, geometry[, ...])

Add QGeometry.

ReadoutResFC.arc(coord_init, coord_center, angle)

Generate x,y coordinates (in terms of shapely.geometry.Point()) of an arc with: a specified initial point, rotation center, and rotation direction (specified by angle in radian (float or integer), positive is ccw).


WARNING: Do NOT use this method during generation of component instance.


Delete the QComponent.


Interface for components to get pin data.

ReadoutResFC.get_template_options(design[, ...])

Creates template options for the Metal Component class required for the class to function, based on the design template; i.e., be created, made, and rendered.


Make the head for readout res


Create the head of the readout resonator. Contains: the circular patch for coupling, the 45 deg line, the 45 deg arc, a short straight segment (of length w) for smooth subtraction.


Parse the options, converting string into interpreted values.


Parse a string, mappable (dict, Dict), iterable (list, tuple) to account for units conversion, some basic arithmetic, and design variables.


Use the element_handler to get a list of all the table names used in QGeometry.


Fetched the component bound dict_value.


Returns a dict of element qgeometry (shapely geometry) of the component as a python dict, where the dict keys are the names of the qgeometry and the corresponding values are the shapely geometries.


Returns a list of element qgeometry (shapely geometry) of the component as a python list of shapely geometries.

ReadoutResFC.qgeometry_plot([ax, plot_kw])

Draw all the qgeometry of the component (polys and path etc.)


Returns the entire element table for the component.


Builds the QComponent.

ReadoutResFC.to_script([thin, is_part_of_chip])

param thin:

If true then any key in the QComponent's options whose value