Rename resonator folder and add missing __init__.py file (#1009)

PositroniumJS · web-flow · commit 82e0fc578d58 · 2025-01-19T19:39:00.000-05:00
* Fix typos and remove unused imports

* Missing __init__.py file in resonator

* Rename folder resonator -&gt; resonators

* Fix typos

* Fix backslash escaping error in sketch
diff --git a/docs/overview.rst b/docs/overview.rst
@@ -103,7 +103,7 @@ Qiskit Metal Overview
    * - Components
      - This is a user interface for the design._components dict. The keys are unique integers, however, this interface allows user to treat the keys as strings.  Set up variables and logger which are used to emulate a dict which is referencing design._components.
    * - DesignPlanar
-     - Metal class for a planar (2D) design, consisting of a single plane chip. Typically assumed to have some CPW geometires.
+     - Metal class for a planar (2D) design, consisting of a single plane chip. Typically assumed to have some CPW geometries.
    * - QDesign
      - QDesign is the base class for Qiskit Metal Designs. A design is the most top-level object in all of Qiskit Metal.  Create a new Metal QDesign.
    * - QNet
diff --git a/docs/tut/1-Overview/1.1-Bird's-eye-view-of-Qiskit-Metal.ipynb b/docs/tut/1-Overview/1.1-Bird's-eye-view-of-Qiskit-Metal.ipynb
@@ -567,7 +567,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "gui.rebuild() # Update the component geoemtry, since we changed the options\n",
+    "gui.rebuild() # Update the component geometry, since we changed the options\n",
     "\n",
     "# Get a list of all the qcomponents in QDesign and then zoom on them.\n",
     "all_component_names = design.components.keys()\n",
diff --git a/docs/tut/1-Overview/1.2-Quick-start.ipynb b/docs/tut/1-Overview/1.2-Quick-start.ipynb
@@ -342,7 +342,7 @@
     "q1.options.pad_width  = '250 um'\n",
     "q1.options.pad_gap    = '50 um'\n",
     "\n",
-    "# Update the geoemtry, since we changed the options\n",
+    "# Update the geometry, since we changed the options\n",
     "gui.rebuild()"
    ]
   },
diff --git a/docs/tut/2-From-components-to-chip/2.01-How-to-use-a-QComponent.ipynb b/docs/tut/2-From-components-to-chip/2.01-How-to-use-a-QComponent.ipynb
@@ -313,7 +313,7 @@
     "q1.options.pad_height = '250 um'\n",
     "q1.options.pad_width  = '300 um'\n",
     "\n",
-    "# Update the geoemtry and render to the gui, since we changed the options\n",
+    "# Update the geometry and render to the gui, since we changed the options\n",
     "gui.rebuild()"
    ]
   },
diff --git a/qiskit_metal/designs/design_base.py b/qiskit_metal/designs/design_base.py
@@ -805,8 +805,8 @@ def parse_value(self, value: Union[Any, List, Dict, Iterable]) -> Any:
                 Returns the number as is. Int to int, etc.
 
 
-        Arithemetic:
-            Some basic arithemetic can be handled as well, such as `'-2 * 1e5 nm'`
+        Arithmetic:
+            Some basic arithmetic can be handled as well, such as `'-2 * 1e5 nm'`
             will yield float(-0.2) when the default units are set to `mm`.
 
         Default units:
diff --git a/qiskit_metal/designs/design_flipchip.py b/qiskit_metal/designs/design_flipchip.py
@@ -29,7 +29,7 @@
 
 class DesignFlipChip(QDesign):
     """Metal class for a flipchip design, consisting of two chips with their device sides facing each other.
-    Typically assumed to have some CPW geometires.
+    Typically assumed to have some CPW geometries.
 
     Inherits QDesign class.
     """
diff --git a/qiskit_metal/designs/design_planar.py b/qiskit_metal/designs/design_planar.py
@@ -26,7 +26,7 @@
 
 class DesignPlanar(QDesign):
     """Metal class for a planar (2D) design, consisting of a single plane chip.
-    Typically assumed to have some CPW geometires.
+    Typically assumed to have some CPW geometries.
 
     Inherits QDesign class.
     """
diff --git a/qiskit_metal/qlibrary/__init__.py b/qiskit_metal/qlibrary/__init__.py
@@ -190,7 +190,7 @@
     from .qubits.transmon_pocket_teeth import TransmonPocketTeeth
     from .qubits.SQUID_loop import SQUID_LOOP
     from .qubits.star_qubit import StarQubit
-    from .resonator.readoutres_fc import ReadoutResFC
-    from .resonator.resonator_lumped import ResonatorLumped
+    from .resonators.readoutres_fc import ReadoutResFC
+    from .resonators.resonator_lumped import ResonatorLumped
 
     from .tlines import anchored_path
diff --git a/qiskit_metal/qlibrary/core/base.py b/qiskit_metal/qlibrary/core/base.py
@@ -768,7 +768,7 @@ def parse_value(
                 Returns the number as is. Int to int, etc.
 
 
-        Arithemetic:
+        Arithmetic:
             Some basic arithmetic can be handled as well, such as `'-2 * 1e5 nm'`
             will yield float(-0.2) when the default units are set to `mm`.
 
diff --git a/qiskit_metal/qlibrary/lumped/resonator_coil_rect.py b/qiskit_metal/qlibrary/lumped/resonator_coil_rect.py
@@ -69,7 +69,7 @@ class ResonatorCoilRect(QComponent):
     modified by the code based on the total length inputed."""
 
     def make(self):
-        """The make function implements the logic that creates the geoemtry
+        """The make function implements the logic that creates the geometry
         (poly, path, etc.) from the qcomponent.options dictionary of
         parameters, and the adds them to the design, using
         qcomponent.add_qgeometry(...), adding in extra needed information, such
@@ -85,7 +85,7 @@ def make(self):
                                       (2 * n - 1))
 
         if x_n <= p.gap + p.line_width:
-            self._error_message = f'Inputted values results in the width of the spiral being too small.'
+            self._error_message = 'Inputted values results in the width of the spiral being too small.'
             self.logger.warning(self._error_message)
             return
 
diff --git a/qiskit_metal/qlibrary/qubits/SQUID_loop.py b/qiskit_metal/qlibrary/qubits/SQUID_loop.py
@@ -29,7 +29,6 @@
 """
 from qiskit_metal import draw, Dict
 from qiskit_metal.qlibrary.core.base import QComponent
-import numpy as np
 
 
 class SQUID_LOOP(QComponent):
diff --git a/qiskit_metal/qlibrary/qubits/transmon_cross.py b/qiskit_metal/qlibrary/qubits/transmon_cross.py
@@ -12,7 +12,6 @@
 # copyright notice, and modified files need to carry a notice indicating
 # that they have been altered from the originals.
 
-import numpy as np
 from qiskit_metal import draw, Dict
 from qiskit_metal.qlibrary.core import BaseQubit
 
@@ -106,7 +105,7 @@ def make(self):
     def make_pocket(self):
         """Makes a basic Crossmon, 4 arm cross."""
 
-        # self.p allows us to directly access parsed values (string -> numbers) form the user option
+        # self.p allows us to directly access parsed values (string -> numbers) from the user option
         p = self.p
 
         cross_width = p.cross_width
@@ -164,7 +163,7 @@ def make_connection_pad(self, name: str):
             name (str) : Name of the connector pad
         """
 
-        # self.p allows us to directly access parsed values (string -> numbers) form the user option
+        # self.p allows us to directly access parsed values (string -> numbers) from the user option
         p = self.p
         cross_width = p.cross_width
         cross_length = p.cross_length
diff --git a/qiskit_metal/qlibrary/qubits/transmon_pocket.py b/qiskit_metal/qlibrary/qubits/transmon_pocket.py
@@ -138,7 +138,7 @@ class TransmonPocket(BaseQubit):
     def make(self):
         """Define the way the options are turned into QGeometry.
 
-        The make function implements the logic that creates the geoemtry
+        The make function implements the logic that creates the geometry
         (poly, path, etc.) from the qcomponent.options dictionary of
         parameters, and the adds them to the design, using
         qcomponent.add_qgeometry(...), adding in extra needed
@@ -150,7 +150,7 @@ def make(self):
     def make_pocket(self):
         """Makes standard transmon in a pocket."""
 
-        # self.p allows us to directly access parsed values (string -> numbers) form the user option
+        # self.p allows us to directly access parsed values (string -> numbers) from the user option
         p = self.p
 
         # extract chip name
@@ -197,18 +197,18 @@ def make_pocket(self):
                            chip=chip)
 
     def make_connection_pads(self):
-        """Makes standard transmon in a pocket."""
+        """Goes through connector pads and makes each one."""
         for name in self.options.connection_pads:
             self.make_connection_pad(name)
 
     def make_connection_pad(self, name: str):
-        """Makes n individual connector.
+        """Makes an individual connector.
 
         Args:
             name (str) : Name of the connector
         """
 
-        # self.p allows us to directly access parsed values (string -> numbers) form the user option
+        # self.p allows us to directly access parsed values (string -> numbers) from the user option
         p = self.p
         pc = self.p.connection_pads[name]  # parser on connector options
 
diff --git a/qiskit_metal/qlibrary/qubits/transmon_pocket_6.py b/qiskit_metal/qlibrary/qubits/transmon_pocket_6.py
@@ -145,7 +145,7 @@ class TransmonPocket6(BaseQubit):
     def make(self):
         """Define the way the options are turned into QGeometry.
 
-        The make function implements the logic that creates the geoemtry
+        The make function implements the logic that creates the geometry
         (poly, path, etc.) from the qcomponent.options dictionary of
         parameters, and the adds them to the design, using
         qcomponent.add_qgeometry(...), adding in extra needed
@@ -157,7 +157,7 @@ def make(self):
     def make_pocket(self):
         """Makes standard transmon in a pocket."""
 
-        # self.p allows us to directly access parsed values (string -> numbers) form the user option
+        # self.p allows us to directly access parsed values (string -> numbers) from the user option
         p = self.p
 
         # since we will reuse these options, parse them once and define them as variables
@@ -195,18 +195,18 @@ def make_pocket(self):
                            width=p.inductor_width)
 
     def make_connection_pads(self):
-        """Makes standard transmon in a pocket."""
+        """Goes through connector pads and makes each one."""
         for name in self.options.connection_pads:
             self.make_connection_pad(name)
 
     def make_connection_pad(self, name: str):
-        """Makes n individual connector.
+        """Makes an individual connector.
 
         Args:
             name (str) : Name of the connector
         """
 
-        # self.p allows us to directly access parsed values (string -> numbers) form the user option
+        # self.p allows us to directly access parsed values (string -> numbers) from the user option
         p = self.p
         pc = self.p.connection_pads[name]  # parser on connector options
 
diff --git a/qiskit_metal/qlibrary/qubits/transmon_pocket_teeth.py b/qiskit_metal/qlibrary/qubits/transmon_pocket_teeth.py
@@ -141,7 +141,7 @@ class TransmonPocketTeeth(BaseQubit):
     def make(self):
         """Define the way the options are turned into QGeometry.
 
-        The make function implements the logic that creates the geoemtry
+        The make function implements the logic that creates the geometry
         (poly, path, etc.) from the qcomponent.options dictionary of
         parameters, and the adds them to the design, using
         qcomponent.add_qgeometry(...), adding in extra needed
@@ -153,7 +153,7 @@ def make(self):
     def make_pocket(self):
         """Makes standard transmon in a pocket."""
 
-        # self.p allows us to directly access parsed values (string -> numbers) form the user option
+        # self.p allows us to directly access parsed values (string -> numbers) from the user option
         p = self.p
         #  pcop = self.p.coupled_pads[name]  # parser on connector options
 
@@ -242,18 +242,18 @@ def make_pocket(self):
                            width=p.inductor_width)
 
     def make_connection_pads(self):
-        """Makes standard transmon in a pocket."""
+        """Goes through connector pads and makes each one."""
         for name in self.options.connection_pads:
             self.make_connection_pad(name)
 
     def make_connection_pad(self, name: str):
-        """Makes n individual connector.
+        """Makes an individual connector.
 
         Args:
             name (str) : Name of the connector
         """
 
-        # self.p allows us to directly access parsed values (string -> numbers) form the user option
+        # self.p allows us to directly access parsed values (string -> numbers) from the user option
         p = self.p
         pc = self.p.connection_pads[name]  # parser on connector options
 
diff --git a/qiskit_metal/qlibrary/resonators/__init__.py b/qiskit_metal/qlibrary/resonators/__init__.py
@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2021.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
diff --git a/qiskit_metal/qlibrary/resonators/readoutres_fc.py b/qiskit_metal/qlibrary/resonators/readoutres_fc.py
diff --git a/qiskit_metal/qlibrary/resonators/resonator_lumped.py b/qiskit_metal/qlibrary/resonators/resonator_lumped.py
diff --git a/qiskit_metal/qlibrary/sample_shapes/circle_caterpillar.py b/qiskit_metal/qlibrary/sample_shapes/circle_caterpillar.py
@@ -55,7 +55,7 @@ class CircleCaterpillar(QComponent):
     TOOLTIP = """A single configurable circle"""
 
     def make(self):
-        """The make function implements the logic that creates the geoemtry
+        """The make function implements the logic that creates the geometry
         (poly, path, etc.) from the qcomponent.options dictionary of
         parameters, and the adds them to the design, using
         qcomponent.add_qgeometry(...), adding in extra needed information, such
diff --git a/qiskit_metal/qlibrary/sample_shapes/circle_raster.py b/qiskit_metal/qlibrary/sample_shapes/circle_raster.py
@@ -51,7 +51,7 @@ class CircleRaster(QComponent):
     TOOLTIP = """A single configurable circle"""
 
     def make(self):
-        """The make function implements the logic that creates the geoemtry
+        """The make function implements the logic that creates the geometry
         (poly, path, etc.) from the qcomponent.options dictionary of
         parameters, and the adds them to the design, using
         qcomponent.add_qgeometry(...), adding in extra needed information, such
diff --git a/qiskit_metal/qlibrary/sample_shapes/n_gon.py b/qiskit_metal/qlibrary/sample_shapes/n_gon.py
@@ -47,7 +47,7 @@ class NGon(QComponent):
     TOOLTIP = """A n-gon polygon"""
 
     def make(self):
-        """The make function implements the logic that creates the geoemtry
+        """The make function implements the logic that creates the geometry
         (poly, path, etc.) from the qcomponent.options dictionary of
         parameters, and the adds them to the design, using
         qcomponent.add_qgeometry(...), adding in extra needed information, such
diff --git a/qiskit_metal/qlibrary/sample_shapes/n_square_spiral.py b/qiskit_metal/qlibrary/sample_shapes/n_square_spiral.py
@@ -63,7 +63,7 @@ class NSquareSpiral(QComponent):
     TOOLTIP = """An n count square spiral"""
 
     def make(self):
-        """The make function implements the logic that creates the geoemtry
+        """The make function implements the logic that creates the geometry
         (poly, path, etc.) from the qcomponent.options dictionary of
         parameters, and the adds them to the design, using
         qcomponent.add_qgeometry(...), adding in extra needed information, such
diff --git a/qiskit_metal/qlibrary/sample_shapes/rectangle.py b/qiskit_metal/qlibrary/sample_shapes/rectangle.py
@@ -46,7 +46,7 @@ class Rectangle(QComponent):
     TOOLTIP = """A single configurable square"""
 
     def make(self):
-        """The make function implements the logic that creates the geoemtry
+        """The make function implements the logic that creates the geometry
         (poly, path, etc.) from the qcomponent.options dictionary of
         parameters, and the adds them to the design, using
         qcomponent.add_qgeometry(...), adding in extra needed information, such
diff --git a/qiskit_metal/qlibrary/sample_shapes/rectangle_hollow.py b/qiskit_metal/qlibrary/sample_shapes/rectangle_hollow.py
@@ -53,7 +53,7 @@ class RectangleHollow(QComponent):
     TOOLTIP = """A single configurable square"""
 
     def make(self):
-        """The make function implements the logic that creates the geoemtry
+        """The make function implements the logic that creates the geometry
         (poly, path, etc.) from the qcomponent.options dictionary of
         parameters, and the adds them to the design, using
         qcomponent.add_qgeometry(...), adding in extra needed information, such
diff --git a/qiskit_metal/qlibrary/terminations/launchpad_wb.py b/qiskit_metal/qlibrary/terminations/launchpad_wb.py
@@ -26,7 +26,7 @@
 
 
 class LaunchpadWirebond(QComponent):
-    """Launch pad to feed/read signals to/from the chip.
+    r"""Launch pad to feed/read signals to/from the chip.
 
     Inherits 'QComponent' class.
 
diff --git a/qiskit_metal/qlibrary/terminations/launchpad_wb_coupled.py b/qiskit_metal/qlibrary/terminations/launchpad_wb_coupled.py
@@ -26,7 +26,7 @@
 
 
 class LaunchpadWirebondCoupled(QComponent):
-    """Launch pad to feed/read signals to/from the chip.
+    r"""Launch pad to feed/read signals to/from the chip.
 
     Inherits 'QComponent' class.
 
diff --git a/qiskit_metal/qlibrary/terminations/launchpad_wb_driven.py b/qiskit_metal/qlibrary/terminations/launchpad_wb_driven.py
@@ -26,7 +26,7 @@
 
 
 class LaunchpadWirebondDriven(QComponent):
-    """Launch pad to feed/read signals to/from the chip.
+    r"""Launch pad to feed/read signals to/from the chip.
 
     Inherits 'QComponent' class.
 
diff --git a/tutorials/1 Overview/1.1 Bird's eye view of Qiskit Metal.ipynb b/tutorials/1 Overview/1.1 Bird's eye view of Qiskit Metal.ipynb
@@ -389,7 +389,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "gui.rebuild() # Update the component geoemtry, since we changed the options\n",
+    "gui.rebuild() # Update the component geometry, since we changed the options\n",
     "\n",
     "# Get a list of all the qcomponents in QDesign and then zoom on them.\n",
     "all_component_names = design.components.keys()\n",
diff --git a/tutorials/1 Overview/1.2 Quick start.ipynb b/tutorials/1 Overview/1.2 Quick start.ipynb
@@ -197,7 +197,7 @@
     "q1.options.pad_width  = '250 um'\n",
     "q1.options.pad_gap    = '50 um'\n",
     "\n",
-    "# Update the geoemtry, since we changed the options\n",
+    "# Update the geometry, since we changed the options\n",
     "gui.rebuild()"
    ]
   },
diff --git a/tutorials/2 From components to chip/A. Using QComponents/2.01 How to use a QComponent.ipynb b/tutorials/2 From components to chip/A. Using QComponents/2.01 How to use a QComponent.ipynb
@@ -206,7 +206,7 @@
     "q1.options.pad_height = '250 um'\n",
     "q1.options.pad_width  = '300 um'\n",
     "\n",
-    "# Update the geoemtry and render to the gui, since we changed the options\n",
+    "# Update the geometry and render to the gui, since we changed the options\n",
     "gui.rebuild()"
    ]
   },
diff --git a/tutorials/Appendix C Circuit examples/F. Small-quantum-chips/Full Physical Design of iSWAP Gates.ipynb b/tutorials/Appendix C Circuit examples/F. Small-quantum-chips/Full Physical Design of iSWAP Gates.ipynb
@@ -60,7 +60,7 @@
    "outputs": [],
    "source": [
     "from qiskit_metal.qlibrary.qubits.transmon_concentric_type_2 import TransmonConcentricType2\n",
-    "from qiskit_metal.qlibrary.resonator.resonator_lumped import ResonatorLumped\n",
+    "from qiskit_metal.qlibrary.resonators.resonator_lumped import ResonatorLumped\n",
     "from qiskit_metal.qlibrary.tlines.straight_path import RouteStraight\n",
     "from qiskit_metal.qlibrary.terminations.launchpad_wb import LaunchpadWirebond\n",
     "from qiskit_metal.qlibrary.terminations.launchpad_wb_coupled import LaunchpadWirebondCoupled"
diff --git a/tutorials/FlipChip_designtutorial.ipynb b/tutorials/FlipChip_designtutorial.ipynb
@@ -43,7 +43,7 @@
     "from qiskit_metal import designs, draw\n",
     "from qiskit_metal import MetalGUI, Dict, Headings\n",
     "from qiskit_metal.qlibrary.qubits.transmon_cross import TransmonCross\n",
-    "from qiskit_metal.qlibrary.resonator.readoutres_fc import ReadoutResFC\n",
+    "from qiskit_metal.qlibrary.resonators.readoutres_fc import ReadoutResFC\n",
     "\n",
     "# suppress deprecation warnings\n",
     "import warnings\n",

Original file line number	Diff line number	Diff line change
`@@ -342,7 +342,7 @@`
`342`	`342`	`"q1.options.pad_width = '250 um'\n",`
`343`	`343`	`"q1.options.pad_gap = '50 um'\n",`
`344`	`344`	`"\n",`
`345`		`- "# Update the geoemtry, since we changed the options\n",`
	`345`	`+ "# Update the geometry, since we changed the options\n",`
`346`	`346`	`"gui.rebuild()"`
`347`	`347`	`]`
`348`	`348`	`},`
Original file line number	Diff line number	Diff line change
`@@ -313,7 +313,7 @@`
`313`	`313`	`"q1.options.pad_height = '250 um'\n",`
`314`	`314`	`"q1.options.pad_width = '300 um'\n",`
`315`	`315`	`"\n",`
`316`		`- "# Update the geoemtry and render to the gui, since we changed the options\n",`
	`316`	`+ "# Update the geometry and render to the gui, since we changed the options\n",`
`317`	`317`	`"gui.rebuild()"`
`318`	`318`	`]`
`319`	`319`	`},`