Skip to content

Commit 80a6212

Browse files
committed
Create imports section and update circuit conversion examples in getting_started.ipynb, fix README typo
1 parent 056d6dd commit 80a6212

2 files changed

Lines changed: 36 additions & 20 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,8 +180,8 @@ for the changes to take effect.
180180

181181
## Attribution
182182

183-
This package was created as part of [Sam Zappa's](https://github.com/zzzappy)'s
183+
This package was created as part of [Sam Zappa](https://github.com/zzzappy)'s
184184
internship at [Riverlane](https://github.com/riverlane) during the Summer
185185
of 2025. Thanks to [Hyeok Kim](https://github.com/see-mike-out),
186-
[Leilani Battle](https://github.com/leibatt) and
186+
[Leilani Battle](https://github.com/leibatt), and
187187
[Abe Asfaw](https://github.com/aasfaw) for guidance and useful discussions.

docs/notebooks/getting_started.ipynb

Lines changed: 34 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,29 @@
2626
"%pip install crumpy"
2727
]
2828
},
29+
{
30+
"cell_type": "markdown",
31+
"id": "3368a263-ff20-4cea-a758-e8310dbe98a5",
32+
"metadata": {},
33+
"source": [
34+
"### Required Imports"
35+
]
36+
},
37+
{
38+
"cell_type": "code",
39+
"execution_count": null,
40+
"id": "b6ef6cbe-0611-489c-915f-f3fc42514dd5",
41+
"metadata": {},
42+
"outputs": [],
43+
"source": [
44+
"from crumpy import CircuitWidget\n",
45+
"\n",
46+
"import stim\n",
47+
"import ipywidgets\n",
48+
"import cirq\n",
49+
"import qiskit"
50+
]
51+
},
2952
{
3053
"cell_type": "markdown",
3154
"id": "947f9453-24b5-4a7f-9d18-2553730bc42c",
@@ -178,8 +201,9 @@
178201
"outputs": [],
179202
"source": [
180203
"widg.curveConnectors = False\n",
204+
"widg.indentCircuitLines = False\n",
181205
"\n",
182-
"# Can also specify at construction, e.g.:\n",
206+
"# Can also specify within CircuitWidget constructor, e.g.:\n",
183207
"# CircuitWidget(stim=..., curveConnectors=False)"
184208
]
185209
},
@@ -282,8 +306,6 @@
282306
"metadata": {},
283307
"outputs": [],
284308
"source": [
285-
"import stim\n",
286-
"\n",
287309
"no_pragma = \"\"\"\n",
288310
"MARKZ(0) 0\n",
289311
"Y 1\n",
@@ -379,8 +401,6 @@
379401
"metadata": {},
380402
"outputs": [],
381403
"source": [
382-
"import ipywidgets\n",
383-
"\n",
384404
"def sliderToCircuit(slider_val):\n",
385405
" base_circuit = \"\"\"\n",
386406
" #!pragma MARKX(0) 0\n",
@@ -441,11 +461,10 @@
441461
"metadata": {},
442462
"outputs": [],
443463
"source": [
444-
"import stim\n",
445-
"\n",
446464
"stim_circuit = stim.Circuit(\"\"\"\n",
447-
"Y 0\n",
448-
"CY 0 1 \n",
465+
"H 0\n",
466+
"CX 0 1\n",
467+
"M 0 1\n",
449468
"\"\"\")\n",
450469
"\n",
451470
"CircuitWidget.from_stim(stim_circuit)"
@@ -466,11 +485,9 @@
466485
"metadata": {},
467486
"outputs": [],
468487
"source": [
469-
"import cirq\n",
470-
"\n",
471488
"q0 = cirq.LineQubit(0)\n",
472489
"q1 = cirq.LineQubit(1)\n",
473-
"cirq_circuit = cirq.Circuit(cirq.X(q0), cirq.CNOT(q0, q1))\n",
490+
"cirq_circuit = cirq.Circuit(cirq.H(q0), cirq.CNOT(q0, q1), cirq.measure(q0, q1))\n",
474491
"\n",
475492
"CircuitWidget.from_cirq(cirq_circuit)"
476493
]
@@ -490,11 +507,10 @@
490507
"metadata": {},
491508
"outputs": [],
492509
"source": [
493-
"import qiskit\n",
494-
"\n",
495-
"qiskit_circuit = qiskit.QuantumCircuit(2)\n",
496-
"qiskit_circuit.z(0)\n",
497-
"qiskit_circuit.cz(0, 1)\n",
510+
"qiskit_circuit = qiskit.QuantumCircuit(2, 2)\n",
511+
"qiskit_circuit.h(0)\n",
512+
"qiskit_circuit.cx(0, 1)\n",
513+
"qiskit_circuit.measure([0, 1], [0, 1])\n",
498514
"\n",
499515
"CircuitWidget.from_qiskit(qiskit_circuit)"
500516
]
@@ -510,7 +526,7 @@
510526
],
511527
"metadata": {
512528
"kernelspec": {
513-
"display_name": "crumpy",
529+
"display_name": "Python 3 (ipykernel)",
514530
"language": "python",
515531
"name": "python3"
516532
},

0 commit comments

Comments
 (0)