stimflow 1.17.dev0__tar.gz → 1.17.dev1780910265__tar.gz

{stimflow-1.17.dev0 → stimflow-1.17.dev1780910265}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stimflow
-Version: 1.17.dev0
+Version: 1.17.dev1780910265
 Summary: A library for creating quantum error correction circuits.
 Home-page: https://github.com/quantumlib/stim
 Author: Craig Gidney

{stimflow-1.17.dev0 → stimflow-1.17.dev1780910265}/setup.py

@@ -19,7 +19,7 @@ with open('README.md', encoding='UTF-8') as f:
 with open('requirements.txt', encoding='UTF-8') as f:
     requirements = f.read().splitlines()
 
-__version__ = '1.17.dev0'
+__version__ = '1.17.dev1780910265'
 
 setup(
     name='stimflow',

{stimflow-1.17.dev0 → stimflow-1.17.dev1780910265}/src/stimflow/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '1.17.dev0'
+__version__ = '1.17.dev1780910265'
 
 from stimflow._chunk import (
     Chunk,

{stimflow-1.17.dev0 → stimflow-1.17.dev1780910265}/src/stimflow/_chunk/_chunk_builder.py

@@ -397,19 +397,29 @@ class ChunkBuilder:
     ) -> None:
         """Declares that the circuit being built should have a given stabilizer flow.
 
-        When chunks are concatenated, their flows are paired up in order to form detectors.
+        When chunks are concatenated, their flows are matched up in order to form detectors.
+        At most one of `start`, `end`, and `measurements` can be set to "auto" in order to
+        infer it.
 
         Args:
             start: Defaults to None (empty). The stabilizer that the flow starts as, at the
                 beginning of the circuit. If the flow begins within the circuit, this should
-                be set to None or an empty PauliMap.
+                be set to None or an empty PauliMap. If this is set to "auto", it will be
+                inferred  by backpropagation from `end` and `measurements`.
             end: Defaults to None (empty). The stabilizer that the flow ends as, at the
                 end of the circuit. If the flow ends within the circuit, this should
-                be set to None or an empty PauliMap.
+                be set to None or an empty PauliMap. If this is set to "auto", it will be
+                inferred by forward propagating from `start` and measurements` (no resets will
+                be included in the forward propagation).
             measurements: Defaults to empty. The keys identifying measurements mediate the flow.
                 For example, if a stabilizer is measured by a circuit then this would
                 typically be a singleton list containing the measurement that reveals
-                the stabilizer's value.
+                the stabilizer's value. If this is set to "auto", it will be inferred from
+                `start` and `end` by Gaussian elimination via `stim.Circuit.flow_generators`.
+
+                Caution: beware using "auto" when the solution isn't unique (e.g. this is
+                common if the circuit includes multiple rounds of stabilizer measurement), as
+                it may select a solution you don't expect.
             ignore_unknown_measurements: Defaults to False. When set to False, unrecognized measurement
                 ids cause the method to raise an exception instead of adding the flow. When set
                 to True, unrecognized measurements are silently discarded.
@@ -428,22 +438,68 @@ class ChunkBuilder:
         Examples:
             >>> import stimflow as sf
             >>> builder = sf.ChunkBuilder()
-            >>> builder.append('R', [0])
-            >>> builder.append('MX', [1j])
-            >>> builder.append('TICK')
-            >>> builder.append('CX', [(1j, 0)])
 
-            >>> builder.add_flow(end=sf.PauliMap.from_xs([0, 1j]), measurements=[1j])
-            >>> builder.add_flow(end=sf.PauliMap.from_zs([0, 1j]))
-            >>> builder.add_flow(start=sf.PauliMap.from_xs([1j]), measurements=[1j])
+            >>> # 0 ───────@─────────── 0
+            >>> #          │
+            >>> # 1 ───R───X───X───M─── 1
+            >>> #              │
+            >>> # 2 ───────────@─────── 2
+            >>> builder.append('R', [1])
+            >>> builder.append('TICK')
+            >>> builder.append('CX', [(0, 1)])
+            >>> builder.append('TICK')
+            >>> builder.append('CX', [(2, 1)])
+            >>> builder.append('TICK')
+            >>> builder.append('M', [1])
+
+            >>> # 0 z━━━━━━━@─────────── 0
+            >>> #           ┃
+            >>> # 1  ───R━━━X━━━X━━[M]── 1
+            >>> #               ┃
+            >>> # 2 z━━━━━━━━━━━@─────── 2
+            >>> builder.add_flow(
+            ...     start=sf.PauliMap({0: 'Z', 2: 'Z'}),
+            ...     measurements=[1],
+            ... )
+
+            >>> # 0 ───────@━━━━━━━━━━━z 0
+            >>> #          ┃
+            >>> # 1 ───R━━━X━━━X━━[M]──  1
+            >>> #              ┃
+            >>> # 2 ───────────@━━━━━━━z 2
+            >>> builder.add_flow(
+            ...     measurements=[1],
+            ...     end=sf.PauliMap({0: 'Z', 2: 'Z'}),
+            ... )
+
+            >>> # 0 x═══════@═══════════x 0
+            >>> #           ║
+            >>> # 1  ───R───X═══X───M───  1
+            >>> #               ║
+            >>> # 2 x═══════════@═══════x 2
+            >>> builder.add_flow(
+            ...     start=sf.PauliMap({0: 'X', 2: 'X'}),
+            ...     end=sf.PauliMap({0: 'X', 2: 'X'}),
+            ... )
+
+            >>> # 0 z━━━━━━━@───────────  0
+            >>> #           ┃
+            >>> # 1  ───R━━━X━━━X━━[M]──  1
+            >>> #               ┃
+            >>> # 2  ───────────@━━━━━━━z 2
+            >>> builder.add_flow(
+            ...     start=sf.PauliMap({0: 'Z'}),
+            ...     measurements=[1],
+            ...     end=sf.PauliMap({2: 'Z'}),
+            ... )
 
             >>> builder.finish_chunk().verify()
         """
         auto_count = (start == "auto") + (end == "auto") + (measurements == "auto")
         if auto_count > 1:
-            raise ValueError("Only one of `start`, `end`, and `ms` can be set to auto.\n"
-                             f"    {start=}"
-                             f"    {measurements=}"
+            raise ValueError("Only one of `start`, `end`, and `measurements` can be set to 'auto'.\n"
+                             f"    {start=}\n"
+                             f"    {measurements=}\n"
                              f"    {end=}")
         if isinstance(start, PauliMap):
             obs_name = start.obs_name

{stimflow-1.17.dev0 → stimflow-1.17.dev1780910265}/src/stimflow/_chunk/_chunk_compiler.py

@@ -18,7 +18,68 @@ if TYPE_CHECKING:
 
 
 class ChunkCompiler:
-    """Compiles appended chunks into a unified circuit."""
+    """Compiles appended chunks into a unified circuit.
+
+    Examples:
+        >>> import stim
+        >>> import stimflow as sf
+
+        >>> zz = sf.PauliMap({0: 'Z', 1 + 1j: 'Z'})
+        >>> idle_chunk = sf.Chunk(
+        ...     stim.Circuit('''
+        ...         QUBIT_COORDS(0, 0) 0
+        ...         QUBIT_COORDS(0, 1) 1
+        ...         QUBIT_COORDS(1, 1) 2
+        ...         R 1
+        ...         TICK
+        ...         CX 0 1
+        ...         TICK
+        ...         CX 2 1
+        ...         TICK
+        ...         M 1
+        ...     '''),
+        ...     flows=[
+        ...         sf.Flow(start=zz, measurement_indices=[0]),
+        ...         sf.Flow(end=zz, measurement_indices=[0]),
+        ...     ]
+        ... )
+
+        >>> compiler = sf.ChunkCompiler()
+        >>> compiler.append_magic_init_chunk()
+        >>> compiler.append(idle_chunk)
+        >>> compiler.append(idle_chunk)
+        >>> compiler.append_magic_end_chunk()
+        >>> compiler.finish_circuit()
+        stim.Circuit('''
+            QUBIT_COORDS(0, 0) 0
+            QUBIT_COORDS(0, 1) 1
+            QUBIT_COORDS(1, 1) 2
+            MPP Z0*Z2
+            TICK
+            R 1
+            TICK
+            CX 0 1
+            TICK
+            CX 2 1
+            TICK
+            M 1
+            DETECTOR(0.5, 0.5, 0) rec[-2] rec[-1]
+            SHIFT_COORDS(0, 0, 1)
+            TICK
+            R 1
+            TICK
+            CX 0 1
+            TICK
+            CX 2 1
+            TICK
+            M 1
+            DETECTOR(0.5, 0.5, 0) rec[-2] rec[-1]
+            SHIFT_COORDS(0, 0, 1)
+            TICK
+            MPP Z0*Z2
+            DETECTOR(0.5, 0.5, 0) rec[-2] rec[-1]
+        ''')
+    """
 
     def __init__(self, *, metadata_func: Callable[[Flow], FlowMetadata] | None = None):
         """
@@ -26,6 +87,66 @@ class ChunkCompiler:
         Args:
             metadata_func: Determines coordinate data appended to detectors
                 (after x, y, and t). Defaults to None (no extra metadata).
+
+        Examples:
+            >>> import stim
+            >>> import stimflow as sf
+
+            >>> zz = sf.PauliMap({0: 'Z', 1 + 1j: 'Z'})
+            >>> idle_chunk = sf.Chunk(
+            ...     stim.Circuit('''
+            ...         QUBIT_COORDS(0, 0) 0
+            ...         QUBIT_COORDS(0, 1) 1
+            ...         QUBIT_COORDS(1, 1) 2
+            ...         R 1
+            ...         TICK
+            ...         CX 0 1
+            ...         TICK
+            ...         CX 2 1
+            ...         TICK
+            ...         M 1
+            ...     '''),
+            ...     flows=[
+            ...         sf.Flow(start=zz, measurement_indices=[0]),
+            ...         sf.Flow(end=zz, measurement_indices=[0]),
+            ...     ]
+            ... )
+
+            >>> compiler = sf.ChunkCompiler()
+            >>> compiler.append_magic_init_chunk()
+            >>> compiler.append(idle_chunk)
+            >>> compiler.append(idle_chunk)
+            >>> compiler.append_magic_end_chunk()
+            >>> compiler.finish_circuit()
+            stim.Circuit('''
+                QUBIT_COORDS(0, 0) 0
+                QUBIT_COORDS(0, 1) 1
+                QUBIT_COORDS(1, 1) 2
+                MPP Z0*Z2
+                TICK
+                R 1
+                TICK
+                CX 0 1
+                TICK
+                CX 2 1
+                TICK
+                M 1
+                DETECTOR(0.5, 0.5, 0) rec[-2] rec[-1]
+                SHIFT_COORDS(0, 0, 1)
+                TICK
+                R 1
+                TICK
+                CX 0 1
+                TICK
+                CX 2 1
+                TICK
+                M 1
+                DETECTOR(0.5, 0.5, 0) rec[-2] rec[-1]
+                SHIFT_COORDS(0, 0, 1)
+                TICK
+                MPP Z0*Z2
+                DETECTOR(0.5, 0.5, 0) rec[-2] rec[-1]
+            ''')
         """
         if metadata_func is None:
             metadata_func = lambda _: FlowMetadata()

{stimflow-1.17.dev0 → stimflow-1.17.dev1780910265}/src/stimflow/_viz/_viz_circuit_html.py

@@ -985,8 +985,9 @@ def _stim_circuit_html_viewer(
     escaped = escaped.replace(", ", ",").replace(" ", "_")
     escaped = escaped.replace("QUBIT_COORDS", "Q")
     escaped = escaped.replace("DETECTOR", "DT")
-    escaped = escaped.replace("(", "%28").replace(")", "%29")
-    escaped = escaped.replace("[", "%5B").replace("]", "%5D")
+    for c in "%()[]&?#/=@ &<>\"'\\":
+        c_esc = '%' + hex(ord(c))[2:].rjust(2, '0').upper()
+        escaped = escaped.replace(c, c_esc)
     local_server_crumble_url = f"""https://algassert.com/crumble#circuit={escaped}"""
 
     from stimflow._core import str_html
@@ -1005,7 +1006,7 @@ def _stim_circuit_html_viewer(
         <button id="btnNext">Next Layer (hotkey: e)</button>
         <a id="crumble-link" href="{local_server_crumble_url}">Open in Crumble</a>
         <div id="viewer"
-         style="border: 1px solid black; margin-bottom: 50px; width: 100%; height: 90vh;
+         style="border: 1px solid black; margin-bottom: 50px; width: 100%; height: 500px;
          resize: both; overflow: auto" tabindex="1" autofocus
          >"""
         + all_svg_image_tags
@@ -1028,6 +1029,9 @@ def _stim_circuit_html_viewer(
                 }
                 let layers = [];
                 let container = document.getElementById("circuit-viewer-container");
+                if (window.self === window.top) {
+                    container.querySelector("#viewer").style.height = "90vh";
+                }
                 container.id = 'circuit-viewer-container-do-not-find-again';
                 while (true) {
                     let svg = container.querySelector('#layer' + layers.length);

{stimflow-1.17.dev0 → stimflow-1.17.dev1780910265}/src/stimflow.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stimflow
-Version: 1.17.dev0
+Version: 1.17.dev1780910265
 Summary: A library for creating quantum error correction circuits.
 Home-page: https://github.com/quantumlib/stim
 Author: Craig Gidney