Update starter notebook with circuit import methods

Author: zzzappy

docs/notebooks/getting_started.ipynb

@@ -177,11 +177,10 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "widg.indentCircuitLines = False\n",
     "widg.curveConnectors = False\n",
     "\n",
-    "# Can also specify at construction:\n",
-    "# CircuitWidget(stim=..., indentCircuitLines=False, curveConnectors=False)"
+    "# Can also specify at construction, e.g.:\n",
+    "# CircuitWidget(stim=..., curveConnectors=False)"
    ]
   },
   {
@@ -276,16 +275,6 @@
     "For example, consider the circuit specification below which omits the '`#!pragma `' preceding its `MARKZ` instruction. Attempting to create a `stim.Circuit` will cause an error:"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "4aa33573",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%pip install stim"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -367,16 +356,6 @@
     "The `traitlets` package used behind the scenes of both `CircuitWidget` and the widgets of `ipywidgets` allows for the composition of multiple widgets through functions like `link` and `dlink`. See the `ipywidgets` [documentation](https://ipywidgets.readthedocs.io/en/latest/examples/Widget%20Events.html#linking-widgets) for more advanced uses."
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "e27207a6",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%pip install ipywidgets"
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "d3f8883a-12d8-4594-aec3-e7b98873ebe2",
@@ -423,25 +402,36 @@
    "id": "ed2c23e0",
    "metadata": {},
    "source": [
-    "## Appendix: Converting to Stim"
+    "### Converting Directly from a Circuit (`stim`, `cirq`, `qiskit`)"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "ed4ffb4e",
    "metadata": {},
    "source": [
-    "If `stim` isn't your quantum circuit package of choice, it may still be possible to utilize CrumPy. Circuits from packages like `cirq` or `qiskit` may be convertible to a `stim` circuit (which can be easily converted to a string for use with `CircuitWidget`). For circuit languages that don't have an existing transpiler that converts to Stim, it may also be possible to convert to [OpenQASM](https://en.wikipedia.org/wiki/OpenQASM), which—while maybe not the most efficient—can be [converted to Cirq](https://quantumai.google/cirq/build/interop#importing_from_openqasm) and finally [converted to Stim](https://github.com/quantumlib/Stim/tree/main/glue/cirq#readme).\n",
+    "CrumPy provides helper methods for creating a `CircuitWidget` directly from 3 popular quantum circuit packages: `stim`, `cirq`, and `qiskit`.\n",
     "\n",
-    "Note that it may not always be possible to convert a circuit between formats (notably, `stim` has a [limited gate set](https://github.com/quantumlib/Stim/tree/main?tab=readme-ov-file#what-is-stim:~:text=There%20is%20no%20support%20for%20non%2DClifford%20operations%2C%20such%20as%20T%20gates%20and%20Toffoli%20gates.%20Only%20stabilizer%20operations%20are%20supported.))."
+    "Even if `stim` isn't your quantum circuit package of choice, it may still be possible to utilize CrumPy. Circuits from packages like `cirq` or `qiskit` may be convertible to a `stim` circuit. For circuit languages that don't have an existing transpiler that converts directly to Stim, it may also be possible to convert to [OpenQASM](https://en.wikipedia.org/wiki/OpenQASM), which can be [converted to Cirq](https://quantumai.google/cirq/build/interop#importing_from_openqasm) and finally [converted to Stim](https://github.com/quantumlib/Stim/tree/main/glue/cirq#readme).\n",
+    "\n",
+    "Note that it may not always be possible to convert a circuit between formats (notably, `stim` has a [limited gate set](https://github.com/quantumlib/Stim/tree/main?tab=readme-ov-file#what-is-stim:~:text=There%20is%20no%20support%20for%20non%2DClifford%20operations%2C%20such%20as%20T%20gates%20and%20Toffoli%20gates.%20Only%20stabilizer%20operations%20are%20supported.)).\n",
+    "\n"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "b4dd3937",
    "metadata": {},
    "source": [
-    "### Example: `cirq` to `stim` with `stimcirq`"
+    "#### Examples"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "30d3991d",
+   "metadata": {},
+   "source": [
+    "`CircuitWidget.from_stim`"
    ]
   },
   {
@@ -451,79 +441,76 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "%pip install cirq\n",
-    "%pip install stimcirq"
+    "import stim\n",
+    "\n",
+    "stim_circuit = stim.Circuit(\"\"\"\n",
+    "Y 0\n",
+    "CY 0 1                            \n",
+    "\"\"\")\n",
+    "\n",
+    "CircuitWidget.from_stim(stim_circuit)"
    ]
   },
   {
    "cell_type": "markdown",
-   "id": "7ad3a4cc",
+   "id": "d2ee059f",
    "metadata": {},
    "source": [
-    "Let's create a simple `cirq` circuit we want converted to `stim` (note that importing cirq might take a minute):"
+    "`CircuitWidget.from_cirq`"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "b089b365",
+   "id": "0649f636",
    "metadata": {},
    "outputs": [],
    "source": [
     "import cirq\n",
     "\n",
     "q0 = cirq.LineQubit(0)\n",
     "q1 = cirq.LineQubit(1)\n",
-    "cirq_circuit = cirq.Circuit(cirq.H(q0), cirq.CNOT(q0, q1))\n",
+    "cirq_circuit = cirq.Circuit(cirq.X(q0), cirq.CNOT(q0, q1))\n",
     "\n",
-    "cirq_circuit"
+    "CircuitWidget.from_cirq(cirq_circuit)"
    ]
   },
   {
    "cell_type": "markdown",
-   "id": "ad52fa36",
+   "id": "ff13af42",
    "metadata": {},
    "source": [
-    "We can use the `stimcirq` package (a sub-package within the Stim project) to convert to a `stim.Circuit`:"
+    "`CircuitWidget.from_qiskit`"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "6f24253b",
+   "id": "8bf6aa0b",
    "metadata": {},
    "outputs": [],
    "source": [
-    "import stimcirq\n",
+    "import qiskit\n",
+    "\n",
+    "qiskit_circuit = qiskit.QuantumCircuit(2)\n",
+    "qiskit_circuit.z(0)\n",
+    "qiskit_circuit.cz(0, 1)\n",
     "\n",
-    "converted_stim = stimcirq.cirq_circuit_to_stim_circuit(cirq_circuit)\n",
-    "converted_stim"
+    "CircuitWidget.from_qiskit(qiskit_circuit)"
    ]
   },
   {
    "cell_type": "markdown",
-   "id": "9e736aee",
+   "id": "b3b2651f",
    "metadata": {},
    "source": [
-    "Note that for `CircuitWidget` compatibility, we need this circuit as a string:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "432fe474",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "converted_stim_str = str(converted_stim)\n",
-    "\n",
-    "CircuitWidget(stim=converted_stim_str)"
+    "While it's not possible to directly add Pauli markers or other Crumble-specific instructions when creating `CircuitWidget`s with these methods, it is possible to read/write the resulting `CircuitWidget`'s `.stim` attribute to get the final converted Stim circuit (in string form), which can then be modified."
    ]
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "crumpy",
    "language": "python",
    "name": "python3"
   },

pyproject.toml

@@ -29,6 +29,7 @@ dynamic = ["version"]
 dependencies = [
     "anywidget>=0.9.18",
     "cirq>=1.3.0",
+    "ipywidgets>=8.1.7",
     "ply>=3.11",
     "qiskit>=2.1.2",
     "stim>=1.15.0",
@@ -47,7 +48,6 @@ Changelog = "https://github.com/Deltakit/crumpy/releases"
 test = [
   "pytest >=6",
   "pytest-cov >=3",
-  "ipywidgets>=8.1.7",
 ]
 dev = [
   { include-group = "test" },