Add crumpy changes in glue/crumble

Add crumpy's .py files (both src and test), update some .js files of Crumble, update .gitignore and package.json for JS bundling, add pyproject.toml with file path updates

Author: zzzappy

.gitignore

@@ -44,3 +44,5 @@ build.ninja
 node_modules
 MODULE.bazel.lock
 .ninja_lock
+glue/crumble/node_modules
+glue/crumble/crumpy/bundle.js

glue/crumble/crumpy/__init__.py

@@ -0,0 +1,115 @@
+"""
+Copyright (c) 2025 Riverlane. All rights reserved.
+
+crumpy: A python library for visualizing Crumble circuits in Jupyter
+"""
+
+# mypy: ignore-errors
+# pylint: disable=abstract-method
+
+from __future__ import annotations
+
+import pathlib
+from importlib.metadata import version
+
+import anywidget
+import cirq
+import qiskit
+import qiskit.qasm3
+import stim
+import stimcirq
+import traitlets
+from cirq.contrib.qasm_import import circuit_from_qasm
+
+__version__ = version(__name__)
+
+__all__ = ["__version__"]
+
+bundler_output_dir = pathlib.Path(__file__).parent
+
+
+class CircuitWidget(anywidget.AnyWidget):
+    """A Jupyter widget for displaying Crumble circuit diagrams.
+
+    Attributes
+    ----------
+    stim : str
+      Stim circuit to be drawn.
+    indentCircuitLines : bool
+      If circuit lines for subsequent qubits in the same row get indented when drawn.
+      Defaults to True (matching Crumble).
+    curveConnectors : bool
+      If connectors (e.g., the line between control and target of a CNOT) can be drawn curved.
+      Defaults to True (matching Crumble).
+    showAnnotationRegions : bool
+      If detector region and observable marks are shown.
+      Defaults to True (matching Crumble).
+    """
+
+    _esm = bundler_output_dir / "bundle.js"
+    stim = traitlets.Unicode(default_value="", help="Stim circuit to be drawn").tag(
+        sync=True
+    )
+    indentCircuitLines = traitlets.Bool(True).tag(sync=True)
+    curveConnectors = traitlets.Bool(True).tag(sync=True)
+    showAnnotationRegions = traitlets.Bool(True).tag(sync=True)
+
+    @staticmethod
+    def from_cirq(cirq_circuit: cirq.Circuit):
+        """Create a `CircuitWidget` from a `cirq.Circuit`.
+
+        `cirq_circuit` will be transpiled to a `stim.Circuit` before use with `CircuitWidget`.
+        `cirq_circuit` must be transpilable to a `stim.Circuit`.
+
+        Parameters
+        ----------
+        cirq_circuit : cirq.Circuit
+            cirq circuit to visualize
+
+        Raises
+        ------
+        TypeError
+            If `cirq_circuit` is unable to be converted to a `stim.Circuit`
+        """
+        try:
+            stim_circuit = stimcirq.cirq_circuit_to_stim_circuit(cirq_circuit)
+            return CircuitWidget(stim=str(stim_circuit))
+        except TypeError as ex:
+            msg = "Unable to translate cirq circuit to stim."
+            raise TypeError(msg) from ex
+
+    @staticmethod
+    def from_qiskit(qiskit_circuit: qiskit.QuantumCircuit):
+        """Create a `CircuitWidget` from a `qiskit.QuantumCircuit`.
+
+        `qiskit_circuit` will be transpiled to a `stim.Circuit` before use with `CircuitWidget`.
+        `qiskit_circuit` must be transpilable to a `stim.Circuit`.
+
+        Parameters
+        ----------
+        qiskit_circuit : qiskit.QuantumCircuit
+            qiskit circuit to visualize
+
+        Raises
+        ------
+        TypeError
+            If `qiskit_circuit` is unable to be converted to a `stim.Circuit`
+        """
+        try:
+            qasm_circuit = qiskit.qasm3.dumps(qiskit_circuit)
+            cirq_circuit = circuit_from_qasm(qasm_circuit)
+            return CircuitWidget.from_cirq(cirq_circuit)
+        except TypeError as ex:
+            msg = "Unable to translate qiskit circuit to stim."
+            raise TypeError(msg) from ex
+
+    @staticmethod
+    def from_stim(stim_circuit: stim.Circuit):
+        """Create a `CircuitWidget` from a `stim.Circuit`.
+
+        Parameters
+        ----------
+        stim_circuit : stim.Circuit
+            stim circuit to visualize
+        """
+        return CircuitWidget(stim=str(stim_circuit))

glue/crumble/crumpy/py.typed

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+import importlib.metadata
+
+import crumpy as m
+
+
+def test_version():
+    assert m.__version__ in importlib.metadata.version("crumpy")

glue/crumble/crumpy/test_package.py

@@ -0,0 +1,124 @@
+# mypy: ignore-errors
+
+from __future__ import annotations
+
+import cirq
+import ipywidgets
+import pytest
+import qiskit
+import stim
+import traitlets
+
+from crumpy import CircuitWidget
+
+
+def test_basic_no_exception():
+    """CircuitWidget should initialize without errors."""
+    CircuitWidget(stim="H 0;", indentCircuitLines=False, curveConnectors=False)
+
+
+def test_bad_stim_instruction_no_exception():
+    """CircuitWidget should not raise an error if given any invalid stim instructions."""
+    CircuitWidget(stim="H 0;thisIsNotAnInstruction 123;CNOT 0 1;")
+
+
+def test_bad_trait_assignment_exception():
+    """Assigning a non-string value to a CircuitWidget's stim should raise a TraitError."""
+    widg = CircuitWidget()
+    with pytest.raises(traitlets.TraitError):
+        widg.stim = 123
+
+
+def test_has_traits():
+    """CircuitWidget should have the expected traits and sync metadata."""
+    widg = CircuitWidget()
+    assert widg.has_trait("stim")
+    assert widg.has_trait("indentCircuitLines")
+    assert widg.has_trait("curveConnectors")
+    assert widg.has_trait("showAnnotationRegions")
+    assert widg.trait_metadata("stim", "sync")
+    assert widg.trait_metadata("indentCircuitLines", "sync")
+    assert widg.trait_metadata("curveConnectors", "sync")
+    assert widg.trait_metadata("showAnnotationRegions", "sync")
+
+
+def test_use_case_dlink():
+    """CircuitWidget should update its stim when linked to an IntSlider via ipywidgets.dlink."""
+
+    def sliderToCircuit(slider_val):
+        return "H 0;" * int(slider_val)
+
+    circuit = CircuitWidget()
+    slider_default_value = 1
+    slider = ipywidgets.IntSlider(
+        description="# of H gates", value=slider_default_value, min=0, max=30
+    )
+    ipywidgets.dlink((slider, "value"), (circuit, "stim"), sliderToCircuit)
+    assert circuit.stim == sliderToCircuit(slider_default_value)
+
+    new_slider_value = 5
+    slider.value = new_slider_value
+    assert circuit.stim == sliderToCircuit(new_slider_value)
+
+    new_stim = "Y 0;"
+    circuit.stim = new_stim
+    assert circuit.stim == new_stim
+
+
+class Test_CircuitImporting:
+    def test_from_cirq_valid(self):
+        """CircuitWidget.from_cirq should create a CircuitWidget with the correct circuit when given a valid (stim-transpilable) cirq circuit."""
+
+        q0 = cirq.LineQubit(0)
+        q1 = cirq.LineQubit(1)
+        cirq_circuit = cirq.Circuit(cirq.H(q0), cirq.CNOT(q0, q1))
+
+        widg = CircuitWidget.from_cirq(cirq_circuit)
+
+        assert "H 0" in widg.stim
+        assert "CNOT 0 1" in widg.stim or "CX 0 1" in widg.stim
+
+    def test_from_cirq_invalid(self):
+        """CircuitWidget.from_cirq should raise an error when given an invalid (non-stim-transpilable) cirq circuit."""
+
+        q0 = cirq.LineQubit(0)
+        q1 = cirq.LineQubit(1)
+        cirq_circuit = cirq.Circuit(cirq.H(q0), cirq.CNOT(q0, q1), cirq.rx(2).on(q0))
+        with pytest.raises(TypeError):
+            CircuitWidget.from_cirq(cirq_circuit)
+
+    def test_from_qiskit_valid(self):
+        """CircuitWidget.from_qiskit should create a CircuitWidget with the correct circuit when given a valid (stim-transpilable) qiskit circuit."""
+
+        qc = qiskit.QuantumCircuit(2)
+        qc.z(0)
+        qc.cx(1, 0)
+
+        widg = CircuitWidget.from_qiskit(qc)
+
+        assert "Z 0" in widg.stim
+        assert "CNOT 1 0" in widg.stim or "CX 1 0" in widg.stim
+
+    def test_from_qiskit_invalid(self):
+        """CircuitWidget.from_qiskit should raise an error when given an invalid (non-stim-transpilable) qiskit circuit."""
+
+        qc = qiskit.QuantumCircuit(2)
+        qc.z(0)
+        qc.cx(1, 0)
+        qc.ry(1.234, 0)
+
+        with pytest.raises(TypeError):
+            CircuitWidget.from_qiskit(qc)
+
+    def test_from_stim(self):
+        """CircuitWidget.from_stim should create a CircuitWidget with the given stim circuit."""
+
+        stim_circuit = stim.Circuit("""
+        X 1
+        CY 0 1
+        """)
+
+        widg = CircuitWidget.from_stim(stim_circuit)
+
+        assert "X 1" in widg.stim
+        assert "CY 0 1" in widg.stim  # also covers alternate name ZCY

glue/crumble/crumpy/test_widget.py

@@ -1,6 +1,61 @@
+/**
+ * Copyright 2023 Craig Gidney
+ * Copyright 2025 Riverlane
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Modifications:
+ * - Refactored for CrumPy
+ */
+
 const pitch = 50;
 const rad = 10;
 const OFFSET_X = -pitch + Math.floor(pitch / 4) + 0.5;
 const OFFSET_Y = -pitch + Math.floor(pitch / 4) + 0.5;
+let indentCircuitLines = true;
+let curveConnectors = true;
+let showAnnotationRegions = true;
+
+const setIndentCircuitLines = (newBool) => {
+  if (typeof newBool !== "boolean") {
+    throw new TypeError(`Expected a boolean, but got ${typeof newBool}`);
+  }
+  indentCircuitLines = newBool;
+};
+
+const setCurveConnectors = (newBool) => {
+  if (typeof newBool !== "boolean") {
+    throw new TypeError(`Expected a boolean, but got ${typeof newBool}`);
+  }
+  curveConnectors = newBool;
+};
+
+const setShowAnnotationRegions = (newBool) => {
+  if (typeof newBool !== "boolean") {
+    throw new TypeError(`Expected a boolean, but got ${typeof newBool}`);
+  }
+  showAnnotationRegions = newBool;
+};
 
-export {pitch, rad, OFFSET_X, OFFSET_Y};
+export {
+  pitch,
+  rad,
+  OFFSET_X,
+  OFFSET_Y,
+  indentCircuitLines,
+  curveConnectors,
+  showAnnotationRegions,
+  setIndentCircuitLines,
+  setCurveConnectors,
+  setShowAnnotationRegions,
+};