Fix typos

qiskit-community · Dec 29, 2024 · df7391d · df7391d
1 parent 8f1d879
commit df7391d
Show file tree

Hide file tree

Showing 17 changed files with 95 additions and 139 deletions.
diff --git a/docs/tut/1-Overview/1.2-Quick-start.ipynb b/docs/tut/1-Overview/1.2-Quick-start.ipynb
diff --git a/docs/tut/1-Overview/1.3-Saving-Your-Chip-Design.ipynb b/docs/tut/1-Overview/1.3-Saving-Your-Chip-Design.ipynb
@@ -197,14 +197,6 @@
    "source": [
     "## Copy the script printed above here. Comment out all other code and run."
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "d002af93",
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {

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
@@ -113,14 +113,14 @@
    "source": [
     "We see that this QComponent consists of two large metallic pads with a thin strip of metal connecting them, corresponding to a Josephson Junction. The transmon qubit is centered at the origin by default. In the GUI, we can see that the ID assigned to our QComponent is \"1\" and that the QComponent class is \"Transmon Pocket.\" \n",
     "\n",
-    "Note that since we didn't give the Qcomponent an explicit name, one was assigned automatically (\"Pocket_1\") which we can also see in the GUI. Taking a look at the actual qcomponent python script, we see that there is a \"short name\" defined in the qcomponent metadata (short_name = \"Pocket\" in the dictionary), which is where this name comes from. "
+    "Note that since we didn't give the QComponent an explicit name, one was assigned automatically (\"Pocket_1\") which we can also see in the GUI. Taking a look at the actual QComponent python script, we see that there is a \"short name\" defined in the QComponent metadata (short_name = \"Pocket\" in the dictionary), which is where this name comes from. "
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "It is easy to give a specific name to a Qcomponent object. We can delete the QComponent \"Pocket_1\" by just clicking the \"Delete all\" button in the Qiskit Metal GUI. Alternatively, this can done by executing the following command, which deletes all components in the design (more on deleting later in this tutorial): "
+    "It is easy to give a specific name to a QComponent object. We can delete the QComponent \"Pocket_1\" by just clicking the \"Delete all\" button in the Qiskit Metal GUI. Alternatively, this can done by executing the following command, which deletes all components in the design (more on deleting later in this tutorial): "
    ]
   },
   {
@@ -156,7 +156,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "The QComponent we've just created as a name \"Q1\" and a Qcomponent ID of 2, since an ID of 1 was already used for the now-deleted \"Pocket_1\" object. It is worth noting that the QComponent we've just created is not functional yet; it's just two rectangular metal pads with a thin strip of metal connecting them. In order for a QComponent to be functional in an actual design, we will need to add a few additional things, such as qpins defining where the transmon pocket connects to coplanar waveguides (CPWs). We will discuss this in more detail later in the tutorial. "
+    "The QComponent we've just created as a name \"Q1\" and a Qcomponent ID of 2, since an ID of 1 was already used for the now-deleted \"Pocket_1\" object. It is worth noting that the QComponent we've just created is not functional yet; it's just two rectangular metal pads with a thin strip of metal connecting them. In order for a QComponent to be functional in an actual design, we will need to add a few additional things, such as QPins defining where the transmon pocket connects to coplanar waveguides (CPWs). We will discuss this in more detail later in the tutorial. "
    ]
   },
   {
@@ -170,14 +170,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "QComponents come with some default options, which are used in the make function of the qcomponent to create the qgeometry that you see in the GUI. These options are parsed by Qiskit Metal, and can be changed using either the GUI or the script API. "
+    "QComponents come with some default options, which are used in the make function of the QComponent to create the qgeometry that you see in the GUI. These options are parsed by Qiskit Metal, and can be changed using either the GUI or the script API. "
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "We can see what the options and other parameters are for our Qcomponent by typing the following command:"
+    "We can see what the options and other parameters are for our QComponent by typing the following command:"
    ]
   },
   {
@@ -409,9 +409,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "We saw in an earlier example how to delete all QComponents in a design using the either the \"design.delete_all_components\" command or by using the \"Delete all\" button in the GUI. But what if we only want to delete specific QComponents without deleting everything in a design? \n",
+    "We saw in an earlier example how to delete all QComponents in a design using either the \"design.delete_all_components\" command or by using the \"Delete all\" button in the GUI. But what if we only want to delete specific QComponents without deleting everything in a design? \n",
     "\n",
-    "We can delete a specific qcomponent using either the GUI or the python API. If you wish to remove a specific QComponent, you can do so using the \"delete_component\" or \"_delete component\" commands. The first takes the string reference to a Qcomponent, while the second takes an integer reference to a QComponent. Suppose we want to remove qubit 'Q1'. Presently, we do not need to pass a Boolean corresponding to whether we want to force the delete (true=1) even if the component has dependencies, or whether the deletion should not be executed in the event the QComponent does have dependencies (false=0). The bool option is for future potential possibilities of having Qcomponents with dependencies. "
+    "We can delete a specific QComponent using either the GUI or the python API. If you wish to remove a specific QComponent, you can do so using the \"delete_component\" or \"_delete_component\" commands. The first takes the string reference to a Qcomponent, while the second takes an integer reference to a QComponent. Suppose we want to remove qubit 'Q1'. Presently, we do not need to pass a Boolean corresponding to whether we want to force the delete (true=1) even if the component has dependencies, or whether the deletion should not be executed in the event the QComponent does have dependencies (false=0). The bool option is for future potential possibilities of having QComponents with dependencies. "
    ]
   },
   {
@@ -454,7 +454,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "In the first example in this notebook, we created a QComponent named \"Pocket_1\" then deleted it and created one with the name \"Q1.\" One can also simply rename a QComponent without deleting it and creating a new one. We can rename a QComponent by using the \"design_rename.component\" command. For example, let's rename \"Q3\" and \"Q4\" to \"Q_three\" and \"Q_four\", respectively. Note that \"Q3\" has a QComponent ID of 4, while \"Q4\" has a Qcomponent ID of 5. "
+    "In the first example in this notebook, we created a QComponent named \"Pocket_1\" then deleted it and created one with the name \"Q1\". One can also simply rename a QComponent without deleting it and creating a new one. We can rename a QComponent by using the \"design_rename.component\" command. For example, let's rename \"Q3\" and \"Q4\" to \"Q_three\" and \"Q_four\", respectively. Note that \"Q3\" has a QComponent ID of 4, while \"Q4\" has a QComponent ID of 5. "
    ]
   },
   {
@@ -489,7 +489,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "In order to enable component overwrite of qcomponents with the same name, we can use the following command:"
+    "In order to enable component overwrite of QComponents with the same name, we can use the following command:"
    ]
   },
   {
@@ -505,7 +505,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "This allows for the qcomponent to be modified and re-built without having to delete it. Without this line, a qcomponent would have to be deleted before recreating it with different options. "
+    "This allows for the QComponent to be modified and re-built without having to delete it. Without this line, a QComponent would have to be deleted before recreating it with different options. "
    ]
   },
   {
@@ -534,13 +534,6 @@
    "source": [
     "gui.main_window.close()"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {

diff --git a/docs/tut/2-From-components-to-chip/2.02-How-to-copy-a-QComponent.ipynb b/docs/tut/2-From-components-to-chip/2.02-How-to-copy-a-QComponent.ipynb
@@ -125,7 +125,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Note that we can also copy multiple qcomponents without passing dictionaries. In this case, the copied qcomponents will sit on top of of the original qcomponents in the layout:"
+    "Note that we can also copy multiple QComponents without passing dictionaries. In this case, the copied QComponents will sit on top of of the original QComponents in the layout:"
    ]
   },
   {
@@ -144,7 +144,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Note also that we can copy multiple qcomponents but only give a dictionary to one of them. The other two dictionaries still need to exist but can be empty: "
+    "Note also that we can copy multiple QComponents but only give a dictionary to one of them. The other two dictionaries still need to exist but can be empty: "
    ]
   },
   {
@@ -186,13 +186,6 @@
    "source": [
     "gui.screenshot()"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {

diff --git a/docs/tut/2-From-components-to-chip/2.11-Routing-101.ipynb b/docs/tut/2-From-components-to-chip/2.11-Routing-101.ipynb
@@ -19,7 +19,7 @@
     "\n",
     "The core class `QRoute` is designed to support different route types, currently only single or double (CPW) wiring. We will use the CPW transmission line in the remainder of this notebook, and in the majority of the other tutorial notebooks.\n",
     "\n",
-    "`QRoute` inherits the generic `QComponent`. QRoute also has two attributes of type `QRouteLead`, which enable close control of the start and end points in a route. We will describe in this notebook how to utilize the `QRouteLead`.`QRoutePoint` is a convenient exchange format for directed points.\n",
+    "`QRoute` inherits the generic `QComponent`. QRoute also has two attributes of type `QRouteLead`, which enable close control of the start and end points in a route. We will describe in this notebook how to utilize the `QRouteLead`. `QRoutePoint` is a convenient exchange format for directed points.\n",
     "\n",
     "`QRoute` is an abstract class, without a `make()` method, thus cannot be instantiated as a design component. `QRoute` is inherited by classes that can be instantiated (have a `make()` method - blue highlights in the image below). By subclassing further, you can implement comprehensive routing algorithms, such as the `RouteMixed`.\n",
     "\n",

diff --git a/docs/tut/2-From-components-to-chip/2.21-Design-a-4-qubit-full-chip.ipynb b/docs/tut/2-From-components-to-chip/2.21-Design-a-4-qubit-full-chip.ipynb
@@ -548,7 +548,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "QDesign enables GDS renderer during init. Let's see what the avilable option defaults are."
+    "QDesign enables GDS renderer during init. Let's see what the available option defaults are."
    ]
   },
   {

diff --git a/docs/tut/4-Analysis/4.02-Eigenmode-and-EPR.ipynb b/docs/tut/4-Analysis/4.02-Eigenmode-and-EPR.ipynb
diff --git a/qiskit_metal/_gui/component_widget_ui.py b/qiskit_metal/_gui/component_widget_ui.py
@@ -97,7 +97,7 @@ def retranslateUi(self, ComponentWidget):
                 "<html><head><meta name=\"qrichtext\" content=\"1\" /><style type=\"text/css\">\n"
                 "p, li { white-space: pre-wrap; }\n"
                 "</style></head><body style=\" font-family:\'.AppleSystemUIFont\'; font-size:13pt; font-weight:400; font-style:normal;\">\n"
-                "<p style=\" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;\"><span style=\" font-family:\'Arial\'; font-size:14pt;\">Help about a component will be displayed here when you select a compoent in the design components dialog. </span></p></body></html>",
+                "<p style=\" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;\"><span style=\" font-family:\'Arial\'; font-size:14pt;\">Help about a component will be displayed here when you select a component in the design components dialog. </span></p></body></html>",
                 None, -1))
         ComponentWidget.setTabText(
             ComponentWidget.indexOf(self.tabHelp),
@@ -110,7 +110,7 @@ def retranslateUi(self, ComponentWidget):
                 "<html><head><meta name=\"qrichtext\" content=\"1\" /><style type=\"text/css\">\n"
                 "p, li { white-space: pre-wrap; }\n"
                 "</style></head><body style=\" font-family:\'.AppleSystemUIFont\'; font-size:13pt; font-weight:400; font-style:normal;\">\n"
-                "<p style=\" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;\"><span style=\" font-family:\'Arial\'; font-size:14pt;\">The source code of a QComponent class will be displayed here when you select a compoent in the design components dialog. </span></p></body></html>",
+                "<p style=\" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;\"><span style=\" font-family:\'Arial\'; font-size:14pt;\">The source code of a QComponent class will be displayed here when you select a component in the design components dialog. </span></p></body></html>",
                 None, -1))
         self.lineSourcePath.setToolTip(
             QtWidgets.QApplication.translate("ComponentWidget",

diff --git a/qiskit_metal/_gui/component_widget_ui.ui b/qiskit_metal/_gui/component_widget_ui.ui
@@ -110,7 +110,7 @@
 &lt;html&gt;&lt;head&gt;&lt;meta name=&quot;qrichtext&quot; content=&quot;1&quot; /&gt;&lt;style type=&quot;text/css&quot;&gt;
 p, li { white-space: pre-wrap; }
 &lt;/style&gt;&lt;/head&gt;&lt;body style=&quot; font-family:'.AppleSystemUIFont'; font-size:13pt; font-weight:400; font-style:normal;&quot;&gt;
-&lt;p style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; font-family:'Arial'; font-size:14pt;&quot;&gt;Help about a component will be displayed here when you select a compoent in the design components dialog. &lt;/span&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+&lt;p style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; font-family:'Arial'; font-size:14pt;&quot;&gt;Help about a component will be displayed here when you select a component in the design components dialog. &lt;/span&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
       </property>
      </widget>
     </item>
@@ -154,7 +154,7 @@ p, li { white-space: pre-wrap; }
 &lt;html&gt;&lt;head&gt;&lt;meta name=&quot;qrichtext&quot; content=&quot;1&quot; /&gt;&lt;style type=&quot;text/css&quot;&gt;
 p, li { white-space: pre-wrap; }
 &lt;/style&gt;&lt;/head&gt;&lt;body style=&quot; font-family:'.AppleSystemUIFont'; font-size:13pt; font-weight:400; font-style:normal;&quot;&gt;
-&lt;p style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; font-family:'Arial'; font-size:14pt;&quot;&gt;The source code of a QComponent class will be displayed here when you select a compoent in the design components dialog. &lt;/span&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+&lt;p style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; font-family:'Arial'; font-size:14pt;&quot;&gt;The source code of a QComponent class will be displayed here when you select a component in the design components dialog. &lt;/span&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
       </property>
      </widget>
     </item>

diff --git a/qiskit_metal/_gui/styles/metal_dark/TODO.txt b/qiskit_metal/_gui/styles/metal_dark/TODO.txt
@@ -1,4 +1,4 @@
-Remmebr to modify the highlight color to red fot the QToolbar hover
+Remember to modify the highlight color to red for the QToolbar hover
 
 QToolBar QToolButton:hover {
   border: 1px solid #e74d10;