.. _how-do-i: ============ How do I...? ============ Start with one of the sections below, or jump to a task further down. .. grid:: 1 2 4 4 :gutter: 3 .. grid-item-card:: :octicon:`device-camera;1.2em` Devices and papers :link: built-with-metal :link-type: doc :class-card: sd-shadow-sm Chips designed with Quantum Metal and the papers behind them. .. grid-item-card:: :octicon:`beaker;1.2em` Reproduced devices :link: research :link-type: doc :class-card: sd-shadow-sm Published chips and results rebuilt as notebooks. .. grid-item-card:: :octicon:`mortar-board;1.2em` Learn :link: tut/index :link-type: doc :class-card: sd-shadow-sm The tutorial course in four parts. .. grid-item-card:: :octicon:`file-code;1.2em` Examples :link: circuit-examples/index :link-type: doc :class-card: sd-shadow-sm Designs and components to copy. Tasks ===== Each card names the call or page that does it and links to where it is explained. .. grid:: 1 2 4 4 :gutter: 2 .. grid-item:: .. button-ref:: hdi-design :ref-type: ref :color: primary :shadow: :expand: Design .. grid-item:: .. button-ref:: hdi-export :ref-type: ref :color: primary :shadow: :expand: Export and view .. grid-item:: .. button-ref:: hdi-simulate :ref-type: ref :color: primary :shadow: :expand: Simulate .. grid-item:: .. button-ref:: hdi-run :ref-type: ref :color: primary :shadow: :expand: Run and automate .. _hdi-design: Design ====== .. grid:: 1 2 3 3 :gutter: 3 :class-container: qm-cards-img .. grid-item-card:: Find a component :img-top: images/qlibrary/TransmonCross.png :class-card: sd-shadow-sm Browse the catalog: one entry per component with its default options and pins. The desktop GUI Library pane lists the same components. +++ :doc:`Component catalog ` · :doc:`API ` .. grid-item-card:: Place a qubit :img-top: images/qlibrary/TransmonPocket.png :class-card: sd-shadow-sm Create it on a design: ``TransmonPocket(design, "Q1", options=dict(pos_x="1mm"))``. +++ :doc:`2.01 Using a QComponent ` · :doc:`1.3 Four-qubit chip ` .. grid-item-card:: Route a CPW :img-top: images/qlibrary/RouteMeander.png :class-card: sd-shadow-sm Use a route such as ``RouteMeander`` or ``RoutePathfinder`` between two pins: ``pin_inputs=dict(start_pin=..., end_pin=...)``. +++ :doc:`2.11 Routing 101 ` · :doc:`2.12 Meander ` .. grid-item-card:: Connect to a pin :img-top: images/qlibrary/LaunchpadWirebond.png :class-card: sd-shadow-sm Every catalog entry lists its pins. Pins carry position, direction and width, and routes attach to them. +++ :doc:`Managing pins ` .. grid-item-card:: Sweep or repeat :img-top: images/qlibrary/Cap3Interdigital.png :class-card: sd-shadow-sm Change options in a loop to compare variants, or build many qubits from code. +++ :doc:`1.5 Parametric design ` · :doc:`2.22 100 qubits ` .. grid-item-card:: Check the design rules :img-top: images/qlibrary/RouteStraight.png :class-card: sd-shadow-sm ``from qiskit_metal.validation import validate; validate(design)`` reports spacing, overlap and connection errors. +++ :doc:`2.24 Design-rule checking ` .. grid-item-card:: Write my own component :img-top: images/qlibrary/NGon.png :class-card: sd-shadow-sm Subclass ``QComponent``, give it default options and a ``make()``. +++ :doc:`2.31 Basic ` · :doc:`2.33 Reusable file ` .. _hdi-export: Export and view =============== .. grid:: 1 2 3 3 :gutter: 3 :class-container: qm-cards-img .. grid-item-card:: Export GDS :img-top: _static/workflow/gds-layers.png :class-card: sd-shadow-sm ``design.renderers.gds.export_to_gds("chip.gds")``. The tutorial covers cheesing (a hole pattern in the ground plane) and the fabrication export. +++ :doc:`3.2 Export to GDS ` .. grid-item-card:: Open the GDS in KLayout :img-top: _static/workflow/gds-layers.png :class-card: sd-shadow-sm Load the layer-properties file and the starter rule deck that ship with the docs. +++ :doc:`GDS in KLayout ` .. grid-item-card:: Save and reload a design :img-top: _static/workflow/design-gui.png :class-card: sd-shadow-sm Keep a design as a file and load it back in another session. +++ :doc:`1.4 Saving your design ` .. _hdi-simulate: Simulate ======== .. grid:: 1 2 3 3 :gutter: 3 :class-container: qm-cards-img .. grid-item-card:: Choose a solver :img-top: _static/home/methods.webp :class-card: sd-shadow-sm Ansys, gmsh + ElmerFEM, gmsh + scikit-fem and Palace compared by what each computes and what it needs installed. +++ :doc:`Simulation pathways ` .. grid-item-card:: Capacitance matrix :img-top: _static/diagrams/lumped-circuit.svg :class-card: sd-shadow-sm Open source with gmsh + ElmerFEM, or Ansys Q3D with the lumped oscillator model. +++ :doc:`4.19 ElmerFEM ` · :doc:`4.01 Ansys ` .. grid-item-card:: Eigenmodes and participation :img-top: _static/workflow/eigenmode-field.png :class-card: sd-shadow-sm Open source with lumped junctions, or Ansys HFSS with energy-participation analysis. +++ :doc:`4.43 scikit-fem ` · :doc:`4.02 Ansys ` .. grid-item-card:: Get a Hamiltonian :img-top: _static/diagrams/epr-participation.svg :class-card: sd-shadow-sm Go from a capacitance matrix or mode participations to qubit parameters. +++ :doc:`4.04 New LOM ` · :doc:`Quantization methods ` .. grid-item-card:: Use Ansys :img-top: _static/workflow/design-gui.png :class-card: sd-shadow-sm Render the design to HFSS or Q3D, then analyze. +++ :doc:`3.3 Render to Ansys ` · :ref:`Part 4, Ansys ` .. grid-item-card:: Reproduce a published chip :img-top: _static/home/gui-chip.webp :class-card: sd-shadow-sm Reproduced devices and results, and layouts of small processors. +++ :doc:`Reproduced devices ` · :doc:`Circuit examples ` .. _hdi-run: Run and automate ================ .. grid:: 1 2 3 3 :gutter: 3 :class-container: qm-cards-img .. grid-item-card:: Run without the GUI :img-top: images/headless-view.png :class-card: sd-shadow-sm ``import qiskit_metal as qm; qm.view(design)`` draws the chip headlessly. +++ :doc:`Desktop GUI or headless ` .. grid-item-card:: Script it or drive it from an assistant :img-top: _static/diagrams/workflow-loop.svg :class-card: sd-shadow-sm The build, check, export loop; a live preview with ``python -m qiskit_metal.watch``; reproducible GDS; using a coding assistant. +++ :doc:`Scripting and agent use ` .. grid-item-card:: Install it :img-top: images/logo.png :class-card: sd-shadow-sm ``pip install quantum-metal``, with extras for the GUI and solvers. +++ :doc:`Installation ` · :doc:`Quick start `