qdesignoptimizer.utils.chip_generation module

Tools for creating and configuring basic chips in Qiskit Metal designs.

class qdesignoptimizer.utils.chip_generation.ChipType(material: str, size_x: str, size_y: str, size_z: str)[source]

Bases: object

Define physical dimensions and material for a designed chip.

material: str
size_x: str
size_y: str
size_z: str
qdesignoptimizer.utils.chip_generation.create_chip_base(chip_name: str, chip_type: ChipType, open_gui: bool = True, design_variables_file: str | None = 'design_variables.json') → tuple[DesignPlanar, MetalGUI][source]

Create and return a basic Qiskit Metal planar chip design.

Parameters:

  • chip_name (str) – The name to assign to the chip design.

  • chip_type (ChipType) – The physical dimensions and material of the chip.

  • open_gui (bool) – Whether to open the Qiskit Metal GUI. Defaults to True.

  • design_variables_file (str, optional) – If not None, load the design variables from this file after creating the chip.

Returns:

A tuple containing:

  • The initialized planar design object.

  • The Metal GUI instance if open_gui is True, otherwise None.

Return type:

tuple[DesignPlanar, MetalGUI]

Example

>>> chip_dimensions = ChipType(size_x="10mm", size_y="10mm", size_z="0.5mm")
>>> design, gui = create_chip_base("my_quantum_chip", chip_dimensions)