cirq-core 1.7.0.dev20250924231107__py3-none-any.whl → 1.7.0.dev20251203004401__py3-none-any.whl

cirq/contrib/quantikz/circuit_to_latex_render_test.py

@@ -0,0 +1,44 @@
+# Copyright 2025 The Cirq Developers
+#
+# 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
+#
+#     https://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.
+
+import pathlib
+
+import numpy as np
+
+import cirq
+from cirq.contrib.quantikz.circuit_to_latex_render import render_circuit
+
+
+def test_render_circuit(tmp_path: pathlib.Path) -> None:
+    q0, q1 = cirq.LineQubit.range(2)
+    circuit = cirq.Circuit(
+        cirq.H(q0),
+        cirq.CNOT(q0, q1),
+        cirq.rx(0.25 * np.pi).on(q1),
+        cirq.measure(q0, q1, key='result'),
+    )
+    # Render and display in Jupyter (if available), also save to a file
+    img_or_path = render_circuit(
+        circuit,
+        output_png_path=tmp_path / "my_circuit.png",
+        output_tex_path=tmp_path / "my_circuit.tex",
+        output_pdf_path=tmp_path / "my_circuit.pdf",
+        fold_at=2,
+        debug=True,
+        wire_labels="qid",
+    )
+    assert img_or_path is not None
+    assert (tmp_path / "my_circuit.png").is_file()
+    assert (tmp_path / "my_circuit.tex").is_file()
+    assert (tmp_path / "my_circuit.pdf").is_file()

cirq/contrib/quantum_volume/quantum_volume.py

@@ -5,8 +5,9 @@ https://arxiv.org/abs/1811.12926.
 
 from __future__ import annotations
 
+from collections.abc import Callable
 from dataclasses import dataclass
-from typing import Callable, TYPE_CHECKING
+from typing import TYPE_CHECKING
 
 import numpy as np
 

cirq/contrib/quimb/density_matrix.py

@@ -2,8 +2,8 @@
 
 from __future__ import annotations
 
+from collections.abc import Sequence
 from functools import lru_cache
-from typing import Sequence
 
 import numpy as np
 import quimb

cirq/contrib/quimb/grid_circuits.py

@@ -14,7 +14,8 @@
 
 from __future__ import annotations
 
-from typing import Iterator, TYPE_CHECKING
+from collections.abc import Iterator
+from typing import TYPE_CHECKING
 
 import cirq
 

cirq/contrib/quimb/grid_circuits_test.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Sequence
+from collections.abc import Sequence
 
 import networkx as nx
 import numpy as np

cirq/contrib/quimb/mps_simulator.py

@@ -21,7 +21,8 @@ from __future__ import annotations
 
 import dataclasses
 import math
-from typing import Any, Sequence, TYPE_CHECKING
+from collections.abc import Sequence
+from typing import Any, TYPE_CHECKING
 
 import numpy as np
 import quimb.tensor as qtn
@@ -42,7 +43,7 @@ class MPSOptions:
 
     # How to split the tensor. Refer to the Quimb documentation for the exact meaning.
     method: str = 'svds'
-    # If integer, the maxmimum number of singular values to keep, regardless of ``cutoff``.
+    # If integer, the maximum number of singular values to keep, regardless of ``cutoff``.
     max_bond: int | None = None
     # Method with which to apply the cutoff threshold. Refer to the Quimb documentation.
     cutoff_mode: str = 'rsum2'
@@ -142,7 +143,7 @@ class MPSSimulator(
 
 
 class MPSTrialResult(simulator_base.SimulationTrialResultBase['MPSState']):
-    """A single trial reult"""
+    """A single trial result"""
 
     def __init__(
         self,

cirq/contrib/quimb/state_vector.py

@@ -3,7 +3,8 @@
 from __future__ import annotations
 
 import warnings
-from typing import cast, Sequence, TYPE_CHECKING
+from collections.abc import Sequence
+from typing import cast, TYPE_CHECKING
 
 import quimb
 import quimb.tensor as qtn

cirq/contrib/quirk/export_to_quirk.py

@@ -16,7 +16,8 @@ from __future__ import annotations
 
 import json
 import urllib.parse
-from typing import Any, cast, Iterable
+from collections.abc import Iterable
+from typing import Any, cast
 
 from cirq import circuits, devices, ops, protocols
 from cirq.contrib.quirk.linearize_circuit import linearize_circuit_qubits

cirq/contrib/quirk/linearize_circuit.py

@@ -14,7 +14,7 @@
 
 from __future__ import annotations
 
-from typing import Callable
+from collections.abc import Callable
 
 from cirq import circuits, devices, ops
 

cirq/contrib/quirk/quirk_gate.py

@@ -14,7 +14,8 @@
 
 from __future__ import annotations
 
-from typing import Any, Callable, cast
+from collections.abc import Callable
+from typing import Any, cast
 
 import numpy as np
 import sympy

cirq/contrib/routing/device.py

@@ -15,7 +15,7 @@
 from __future__ import annotations
 
 import itertools
-from typing import Iterable
+from collections.abc import Iterable
 
 import networkx as nx
 

cirq/contrib/routing/greedy.py

@@ -15,7 +15,8 @@
 from __future__ import annotations
 
 import itertools
-from typing import Callable, cast, Iterable, Sequence, TYPE_CHECKING
+from collections.abc import Callable, Iterable, Sequence
+from typing import cast, TYPE_CHECKING
 
 import networkx as nx
 import numpy as np

cirq/contrib/routing/initialization.py

@@ -15,7 +15,8 @@
 from __future__ import annotations
 
 import itertools
-from typing import cast, Hashable, TYPE_CHECKING
+from collections.abc import Hashable
+from typing import cast, TYPE_CHECKING
 
 import networkx as nx
 from sortedcontainers import SortedDict, SortedSet

cirq/contrib/routing/router.py

@@ -14,7 +14,8 @@
 
 from __future__ import annotations
 
-from typing import Callable, TYPE_CHECKING
+from collections.abc import Callable
+from typing import TYPE_CHECKING
 
 from cirq import circuits, protocols
 from cirq.contrib.routing.greedy import route_circuit_greedily

cirq/contrib/routing/swap_network.py

@@ -14,7 +14,8 @@
 
 from __future__ import annotations
 
-from typing import Iterable, TYPE_CHECKING
+from collections.abc import Iterable
+from typing import TYPE_CHECKING
 
 import cirq.contrib.acquaintance as cca
 from cirq import ops

cirq/contrib/routing/utils.py

@@ -16,7 +16,8 @@ from __future__ import annotations
 
 import operator
 import re
-from typing import Callable, Iterable, TYPE_CHECKING
+from collections.abc import Callable, Iterable
+from typing import TYPE_CHECKING
 
 import networkx as nx
 

cirq/contrib/shuffle_circuits/shuffle_circuits_with_readout_benchmarking.py

@@ -17,7 +17,8 @@
 from __future__ import annotations
 
 import time
-from typing import Sequence, TYPE_CHECKING
+from collections.abc import Sequence
+from typing import TYPE_CHECKING
 
 import attrs
 import numpy as np
@@ -105,7 +106,7 @@ def _generate_readout_calibration_circuits(
         readout_calibration_circuits.append(
             circuits.Circuit(
                 [bit_to_gate[bit](qubit) for bit, qubit in zip(bitstr, qubits)]
-                + [ops.M(qubits, key="m")]
+                + [ops.M(qubits, key="result")]
             )
         )
     return readout_calibration_circuits, random_bitstrings
@@ -137,11 +138,12 @@ def _generate_parameterized_readout_calibration_circuit_with_sweep(
 
     exp_symbols = [sympy.Symbol(f'exp_{qubit}') for qubit in qubits]
     parameterized_readout_calibration_circuit = circuits.Circuit(
-        [ops.X(qubit) ** exp for exp, qubit in zip(exp_symbols, qubits)], ops.M(*qubits, key="m")
+        [ops.X(qubit) ** exp for exp, qubit in zip(exp_symbols, qubits)],
+        ops.M(*qubits, key="result"),
     )
     sweep_params = []
     for bitstr in random_bitstrings:
-        sweep_params.append({exp: bit for exp, bit in zip(exp_symbols, bitstr)})
+        sweep_params.append({str(exp): bit for exp, bit in zip(exp_symbols, bitstr)})
 
     return parameterized_readout_calibration_circuit, sweep_params, random_bitstrings
 
@@ -272,7 +274,7 @@ def _analyze_readout_results(
     )
 
 
-@deprecated(deadline="v2.0", fix="Use run_shuffled_circuits_with_readout_benchmarking() instead.")
+@deprecated(deadline="v1.8", fix="Use run_shuffled_circuits_with_readout_benchmarking() instead.")
 def run_shuffled_with_readout_benchmarking(
     input_circuits: list[circuits.Circuit],
     sampler: work.Sampler,

cirq/contrib/shuffle_circuits/shuffle_circuits_with_readout_benchmarking_test.py

@@ -15,7 +15,7 @@
 from __future__ import annotations
 
 import itertools
-from typing import Sequence
+from collections.abc import Sequence
 
 import numpy as np
 import pytest
@@ -401,7 +401,7 @@ def test_deprecated_run_shuffled_with_readout_benchmarking() -> None:
     num_random_bitstrings = 100
 
     # Test with an integer seed.
-    with cirq.testing.assert_deprecated(deadline='v2.0', count=1):
+    with cirq.testing.assert_deprecated(deadline='v1.8', count=1):
         measurements_seed, results_seed = sc_readout.run_shuffled_with_readout_benchmarking(
             input_circuits=input_circuits,
             sampler=sampler,
@@ -420,7 +420,7 @@ def test_deprecated_run_shuffled_with_readout_benchmarking() -> None:
         assert 0.18 < error < 0.22
 
     # Test with qubits=None to cover the auto-detection branch.
-    with cirq.testing.assert_deprecated(deadline='v2.0', count=1):
+    with cirq.testing.assert_deprecated(deadline='v1.8', count=1):
         _, results_none = sc_readout.run_shuffled_with_readout_benchmarking(
             input_circuits=input_circuits,
             sampler=sampler,
@@ -434,7 +434,7 @@ def test_deprecated_run_shuffled_with_readout_benchmarking() -> None:
     assert set(qlist_none) == set(qubits)
 
     # Test circuit_repetitions must be > 0
-    with cirq.testing.assert_deprecated(deadline="v2.0", count=1):
+    with cirq.testing.assert_deprecated(deadline="v1.8", count=1):
         with pytest.raises(ValueError, match="Must provide non-zero circuit_repetitions."):
             sc_readout.run_shuffled_with_readout_benchmarking(
                 input_circuits,
@@ -446,7 +446,7 @@ def test_deprecated_run_shuffled_with_readout_benchmarking() -> None:
             )
 
     # Test num_random_bitstrings must be >= 0
-    with cirq.testing.assert_deprecated(deadline="v2.0", count=1):
+    with cirq.testing.assert_deprecated(deadline="v1.8", count=1):
         with pytest.raises(ValueError, match="Must provide zero or more num_random_bitstrings."):
             sc_readout.run_shuffled_with_readout_benchmarking(
                 input_circuits,
@@ -458,7 +458,7 @@ def test_deprecated_run_shuffled_with_readout_benchmarking() -> None:
             )
 
     # Test readout_repetitions must be > 0
-    with cirq.testing.assert_deprecated(deadline="v2.0", count=1):
+    with cirq.testing.assert_deprecated(deadline="v1.8", count=1):
         with pytest.raises(
             ValueError, match="Must provide non-zero readout_repetitions for readout calibration."
         ):

cirq/devices/device.py

@@ -15,7 +15,8 @@
 from __future__ import annotations
 
 import abc
-from typing import Iterable, TYPE_CHECKING
+from collections.abc import Iterable
+from typing import TYPE_CHECKING
 
 import networkx as nx
 

cirq/devices/grid_device_metadata.py

@@ -16,7 +16,8 @@
 
 from __future__ import annotations
 
-from typing import cast, Iterable, Mapping, TYPE_CHECKING
+from collections.abc import Iterable, Mapping
+from typing import cast, TYPE_CHECKING
 
 import networkx as nx
 

cirq/devices/grid_qubit.py

@@ -17,7 +17,8 @@ from __future__ import annotations
 import abc
 import functools
 import weakref
-from typing import Any, Iterable, Self, TYPE_CHECKING
+from collections.abc import Iterable
+from typing import Any, Self, TYPE_CHECKING
 
 import numpy as np
 
@@ -285,7 +286,7 @@ class GridQid(_BaseGridQid):
 
     @staticmethod
     def from_diagram(diagram: str, dimension: int) -> list[GridQid]:
-        """Parse ASCII art device layout into a device.
+        r"""Parse ASCII art device layout into a device.
 
         As an example, the below diagram will create a list of GridQid in a
         pyramid structure.
@@ -322,7 +323,7 @@ class GridQid(_BaseGridQid):
                 a row. Alphanumeric characters are assigned as qid.
                 Dots ('.'), dashes ('-'), and spaces (' ') are treated as
                 empty locations in the grid. If diagram has characters other
-                than alphanumerics, spacers, and newlines ('\\n'), an error will
+                than alphanumerics, spacers, and newlines ('\n'), an error will
                 be thrown. The top-left corner of the diagram will be have
                 coordinate (0, 0).
 
@@ -439,7 +440,7 @@ class GridQubit(_BaseGridQid):
 
     @staticmethod
     def from_diagram(diagram: str) -> list[GridQubit]:
-        """Parse ASCII art into device layout info.
+        r"""Parse ASCII art into device layout info.
 
         As an example, the below diagram will create a list of
         GridQubit in a pyramid structure.
@@ -476,7 +477,7 @@ class GridQubit(_BaseGridQid):
                 a row. Alphanumeric characters are assigned as qid.
                 Dots ('.'), dashes ('-'), and spaces (' ') are treated as
                 empty locations in the grid. If diagram has characters other
-                than alphanumerics, spacers, and newlines ('\\n'), an error will
+                than alphanumerics, spacers, and newlines ('\n'), an error will
                 be thrown. The top-left corner of the diagram will be have
                 coordinate (0,0).
 
@@ -503,7 +504,7 @@ class GridQubit(_BaseGridQid):
 
 
 def _ascii_diagram_to_coords(diagram: str) -> list[tuple[int, int]]:
-    """Parse ASCII art device layout into info about qids coordinates
+    r"""Parse ASCII art device layout into info about qids coordinates
 
     Args:
         diagram: String representing the qid layout. Each line represents

cirq/devices/insertion_noise_model.py

@@ -15,7 +15,8 @@
 from __future__ import annotations
 
 import dataclasses
-from typing import Any, Mapping, Sequence, TYPE_CHECKING
+from collections.abc import Mapping, Sequence
+from typing import Any, TYPE_CHECKING
 
 from cirq import devices
 from cirq.devices import noise_utils

cirq/devices/line_qubit.py

@@ -17,7 +17,8 @@ from __future__ import annotations
 import abc
 import functools
 import weakref
-from typing import Any, Iterable, Self, Sequence, TYPE_CHECKING
+from collections.abc import Iterable, Sequence
+from typing import Any, Self, TYPE_CHECKING
 
 from cirq import ops, protocols
 

cirq/devices/named_topologies.py

@@ -16,8 +16,9 @@ from __future__ import annotations
 
 import abc
 import warnings
+from collections.abc import Callable, Iterable, Sequence
 from dataclasses import dataclass
-from typing import Any, Callable, Iterable, Sequence, TYPE_CHECKING, Union
+from typing import Any, TYPE_CHECKING, Union
 
 import networkx as nx
 from matplotlib import pyplot as plt

cirq/devices/noise_model.py

@@ -14,7 +14,8 @@
 
 from __future__ import annotations
 
-from typing import Any, Callable, Iterable, Sequence, TYPE_CHECKING, Union
+from collections.abc import Callable, Iterable, Sequence
+from typing import Any, TYPE_CHECKING, Union
 
 from cirq import ops, protocols, value
 from cirq._doc import document

cirq/devices/noise_model_test.py

@@ -14,7 +14,7 @@
 
 from __future__ import annotations
 
-from typing import Sequence
+from collections.abc import Sequence
 
 import numpy as np
 import pytest

cirq/devices/noise_properties.py

@@ -22,7 +22,8 @@ noise models to produce a single noise model which replicates device noise.
 from __future__ import annotations
 
 import abc
-from typing import Iterable, Sequence, TYPE_CHECKING
+from collections.abc import Iterable, Sequence
+from typing import TYPE_CHECKING
 
 from cirq import _import, devices, ops, protocols, value
 from cirq.devices.noise_utils import PHYSICAL_GATE_TAG

cirq/devices/superconducting_qubits_noise_properties_test.py

@@ -14,7 +14,8 @@
 
 from __future__ import annotations
 
-from typing import Any, Sequence
+from collections.abc import Sequence
+from typing import Any
 
 import numpy as np
 import pytest

cirq/devices/thermal_noise_model.py

@@ -15,7 +15,8 @@
 from __future__ import annotations
 
 import functools
-from typing import Sequence, TYPE_CHECKING
+from collections.abc import Sequence
+from typing import TYPE_CHECKING
 
 import numpy as np
 import sympy

cirq/experiments/__init__.py

@@ -90,3 +90,5 @@ from cirq.experiments.z_phase_calibration import (
     z_phase_calibration_workflow as z_phase_calibration_workflow,
     calibrate_z_phases as calibrate_z_phases,
 )
+
+from cirq.experiments.ghz_2d import generate_2d_ghz_circuit as generate_2d_ghz_circuit

cirq/experiments/benchmarking/parallel_xeb.py

@@ -16,8 +16,9 @@
 
 from __future__ import annotations
 
+from collections.abc import Iterable, Mapping, Sequence
 from concurrent import futures
-from typing import Iterable, Mapping, overload, Sequence, TYPE_CHECKING, Union
+from typing import overload, TYPE_CHECKING, Union
 
 import attrs
 import networkx as nx

cirq/experiments/benchmarking/parallel_xeb_test.py

@@ -15,8 +15,8 @@
 from __future__ import annotations
 
 import itertools
+from collections.abc import Iterator
 from concurrent import futures
-from typing import Iterator
 
 import networkx as nx
 import numpy as np

cirq/experiments/fidelity_estimation.py

@@ -16,7 +16,8 @@
 
 from __future__ import annotations
 
-from typing import Callable, Mapping, Sequence, TYPE_CHECKING
+from collections.abc import Callable, Mapping, Sequence
+from typing import TYPE_CHECKING
 
 import numpy as np
 

cirq/experiments/fidelity_estimation_test.py

@@ -15,7 +15,7 @@
 from __future__ import annotations
 
 import itertools
-from typing import Sequence
+from collections.abc import Sequence
 
 import numpy as np
 import pytest