iqm-pulse 10.3.0__tar.gz → 10.4.0__tar.gz

{iqm_pulse-10.3.0 → iqm_pulse-10.4.0}/CHANGELOG.rst

@@ -2,6 +2,15 @@
 Changelog
 =========
 
+Version 10.4.0 (2025-08-12)
+===========================
+
+Features
+--------
+
+- Allow deprecating quantum operations and/or their implementations while still preserving them in the quantum operation
+  library (the names of deprecated canonical operations are still reserved).
+
 Version 10.3.0 (2025-08-11)
 ===========================
 

{iqm_pulse-10.3.0/src/iqm_pulse.egg-info → iqm_pulse-10.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-pulse
-Version: 10.3.0
+Version: 10.4.0
 Summary: A Python-based project for providing interface and implementations for control pulses.
 Author-email: IQM Finland Oy <info@meetiqm.com>
 License:                                  Apache License

{iqm_pulse-10.3.0 → iqm_pulse-10.4.0}/src/iqm/pulse/builder.py

@@ -45,7 +45,7 @@ from iqm.pulse.gate_implementation import (
     OpCalibrationDataTree,
 )
 from iqm.pulse.gates import _validate_implementation, get_implementation_class
-from iqm.pulse.gates.default_gates import _quantum_ops_library
+from iqm.pulse.gates.default_gates import _deprecated_implementations, _deprecated_ops, _quantum_ops_library
 from iqm.pulse.playlist.channel import ChannelProperties, ProbeChannelProperties
 from iqm.pulse.playlist.instructions import (
     AcquisitionMethod,
@@ -184,8 +184,12 @@ def validate_quantum_circuit(
 def build_quantum_ops(ops: dict[str, dict[str, Any]]) -> QuantumOpTable:
     """Builds the table of known quantum operations.
 
-    Hardcoded default native ops table is extended by the ones in ``ops``.
-    In case of name collisions, the content of ``ops`` takes priority over the defaults.
+    Hardcoded canonical ops table is extended by the ones in ``ops``.
+    In case of name collisions, the content of ``ops`` takes priority over the defaults,
+    with the following caveats:
+
+    * canonical implementation names cannot be redefined, and
+    * for canonical operations you can only change :attr:`implementations` and :attr:`defaults_for_locus`.
 
     Args:
         ops: Contents of the ``gate_definitions`` section defining
@@ -204,7 +208,23 @@ def build_quantum_ops(ops: dict[str, dict[str, Any]]) -> QuantumOpTable:
         ValueError: Operation attributes don't match defaults or are invalid.
 
     """
-    op_table = copy.deepcopy(_quantum_ops_library)
+    # build the table of native ops
+    op_table = {}
+    for op_name, op in _quantum_ops_library.items():
+        # filter out deprecated ops, unless requested by the user in ``ops``
+        if op_name in _deprecated_ops and op_name not in ops:
+            continue
+
+        new_op = copy.deepcopy(op)  # to prevent modifications to the hardcoded table
+        if (deprecated_impls := _deprecated_implementations.get(op_name)) is not None:
+            # filter out deprecated implementations
+            non_deprecated = {
+                impl_name: impl for impl_name, impl in op.implementations.items() if impl_name not in deprecated_impls
+            }
+            new_op = replace(op, implementations=non_deprecated)
+        op_table[op_name] = new_op
+
+    # add ops defined by the user
     for op_name, op_definition in ops.items():
         # prepare the implementations
         implementations: dict[str, type[GateImplementation]] = {}
@@ -236,9 +256,9 @@ def build_quantum_ops(ops: dict[str, dict[str, Any]]) -> QuantumOpTable:
                     f"appear in the implementations dict."
                 )
 
-        # prepare a new op, or modify the existing one
-        if (old_op := op_table.get(op_name)) is not None:
-            # known op: only some fields can be redefined, and they have been popped out already
+        if (old_op := _quantum_ops_library.get(op_name)) is not None:
+            # modify a canonical operation
+            # only some fields can be modified, and they have been popped out already from op_definition
             if op_definition:
                 # TODO this should be an error, but there are so many old experiment.yml files in use
                 # that still have the old syntax that being strict about this would be disruptive.
@@ -247,15 +267,17 @@ def build_quantum_ops(ops: dict[str, dict[str, Any]]) -> QuantumOpTable:
                     f"'{op_name}' is a canonical operation, which means the fields {set(op_definition)} "
                     "provided by the user may not be changed."
                 )
-            op_table[op_name] = replace(old_op, implementations=implementations, defaults_for_locus=defaults_for_locus)
+
+            op = replace(old_op, implementations=implementations, defaults_for_locus=defaults_for_locus)
         else:
-            # new op
-            op_table[op_name] = QuantumOp(
+            # entirely new quantum operation defined by the user
+            op = QuantumOp(
                 name=op_name,
                 implementations=implementations,
                 defaults_for_locus=defaults_for_locus,
                 **op_definition,
             )
+        op_table[op_name] = op
 
     return op_table
 

{iqm_pulse-10.3.0 → iqm_pulse-10.4.0}/src/iqm/pulse/gates/__init__.py

@@ -46,7 +46,7 @@ from iqm.pulse.gates.cz import (
     FluxPulseGate_CRF_CRF,
     FluxPulseGate_TGSS_CRF,
 )
-from iqm.pulse.gates.default_gates import _default_implementations, _quantum_ops_library
+from iqm.pulse.gates.default_gates import _implementation_library, _quantum_ops_library
 from iqm.pulse.gates.delay import Delay
 from iqm.pulse.gates.flux_multiplexer import FluxMultiplexer_SampleLinear
 from iqm.pulse.gates.measure import Measure_Constant, Measure_Constant_Qnd, Shelved_Measure_Constant
@@ -157,7 +157,7 @@ def _validate_implementation(
         ValueError: A canonical implementation name is being redefined.
 
     """
-    default_implementations = _default_implementations.get(op_name, {})
+    default_implementations = _implementation_library.get(op_name, {})
 
     # check if the implementation name is canonical for this op
     if (impl_class := default_implementations.get(impl_name)) is not None:

{iqm_pulse-10.3.0 → iqm_pulse-10.4.0}/src/iqm/pulse/gates/default_gates.py

@@ -15,7 +15,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Final
 
 import numpy as np
 
@@ -63,7 +63,7 @@ if TYPE_CHECKING:
     from iqm.pulse.gate_implementation import GateImplementation
 
 
-_default_implementations: dict[str, dict[str, type[GateImplementation]]] = {
+_implementation_library: dict[str, dict[str, type[GateImplementation]]] = {
     "barrier": {"": Barrier},
     "delay": {"wait": Delay},
     "measure": {
@@ -105,9 +105,11 @@ _default_implementations: dict[str, dict[str, type[GateImplementation]]] = {
     "reset_wait": {"reset_wait": Reset_Wait},
     "flux_multiplexer": {"sample_linear": FluxMultiplexer_SampleLinear},
 }
-"""Canonical implementation names for the canonical quantum operations.
-A collection of mappings between default implementation names and their GateImplementation classes,
-for different gates."""
+"""For each canonical quantum operation name, maps its canonical implementation implementation names
+to their GateImplementation classes.
+
+Canonical names are reserved, and the users cannot redefine them.
+"""
 
 _quantum_ops_library = {
     op.name: op
@@ -115,101 +117,113 @@ _quantum_ops_library = {
         QuantumOp(
             "barrier",
             0,
-            implementations=_default_implementations["barrier"],  # type: ignore[arg-type]
+            implementations=_implementation_library["barrier"],
             symmetric=True,
         ),
         QuantumOp(
             "delay",
             0,
             ("duration",),
-            implementations=_default_implementations["delay"],  # type: ignore[arg-type]
+            implementations=_implementation_library["delay"],
             symmetric=True,
         ),
         QuantumOp(
             "measure",
             0,
             ("key",),
-            implementations=_default_implementations["measure"],  # type: ignore[arg-type]
+            implementations=_implementation_library["measure"],
             factorizable=True,
         ),
         QuantumOp(
             "prx",
             1,
             ("angle", "phase"),
-            implementations=_default_implementations["prx"],  # type: ignore[arg-type]
+            implementations=_implementation_library["prx"],
             unitary=get_unitary_prx,
         ),
         QuantumOp(
             "prx_12",
             1,
             ("angle", "phase"),
-            implementations=_default_implementations["prx_12"],  # type: ignore[arg-type]
+            implementations=_implementation_library["prx_12"],
         ),
         QuantumOp(
             "u",
             1,
             ("theta", "phi", "lam"),
-            implementations=_default_implementations["u"],  # type: ignore[arg-type]
+            implementations=_implementation_library["u"],
             unitary=get_unitary_u,
         ),
         QuantumOp(
             "sx",
             1,
-            implementations=_default_implementations["sx"],  # type: ignore[arg-type]
+            implementations=_implementation_library["sx"],
             unitary=lambda: get_unitary_prx(np.pi / 2, 0),
         ),
         QuantumOp(
             "rz",
             1,
             ("angle",),
-            implementations=_default_implementations["rz"],  # type: ignore[arg-type]
+            implementations=_implementation_library["rz"],
             unitary=get_unitary_rz,
         ),
         QuantumOp(
             "rz_physical",
             1,
-            implementations=_default_implementations["rz_physical"],  # type: ignore[arg-type]
+            implementations=_implementation_library["rz_physical"],
         ),
         QuantumOp(
             "cz",
             2,
             (),
-            implementations=_default_implementations["cz"],  # type: ignore[arg-type]
+            implementations=_implementation_library["cz"],
             symmetric=True,
             unitary=lambda: np.diag([1.0, 1.0, 1.0, -1.0]),
         ),
         QuantumOp(
             "move",
             2,
-            implementations=_default_implementations["move"],  # type: ignore[arg-type]
+            implementations=_implementation_library["move"],
         ),
         QuantumOp(
             "cc_prx",
             1,
             ("angle", "phase", "feedback_qubit", "feedback_key"),
-            implementations=_default_implementations["cc_prx"],  # type: ignore[arg-type]
+            implementations=_implementation_library["cc_prx"],
         ),
         QuantumOp(
             "reset",
             0,
-            implementations=_default_implementations["reset"],  # type: ignore[arg-type]
+            implementations=_implementation_library["reset"],
             symmetric=True,
             factorizable=True,
         ),
         QuantumOp(
             "reset_wait",
             0,
-            implementations=_default_implementations["reset_wait"],  # type: ignore[arg-type]
+            implementations=_implementation_library["reset_wait"],
             symmetric=True,
             factorizable=True,
         ),
         QuantumOp(
             "flux_multiplexer",
             0,
-            implementations=_default_implementations["flux_multiplexer"],  # type: ignore[arg-type]
+            implementations=_implementation_library["flux_multiplexer"],
         ),
     ]
 }
-"""Library of the current canonical quantum operations provided by iqm-pulse."""
-# NOTE If a canonical operation is removed in the future, consider adding a second dict for former
-# canonical operations so that we retain information about them.
+"""Canonical quantum operations provided by iqm-pulse.
+
+Their names are reserved, and the users cannot redefine them.
+"""
+
+_deprecated_ops: Final[set[str]] = set()
+"""Names of canonical quantum operations that are deprecated.
+
+They are not included by default in ScheduleBuilder unless the user specifically requests them."""
+_deprecated_implementations: Final[dict[str, set[str]]] = {}
+"""For each canonical quantum operation name, canonical implementation names that are deprecated.
+
+They are not included by default in ScheduleBuilder unless the user specifically requests them."""
+# TODO: deprecate gaussian_smoothed_square and everything with the tgss waveform as that is considered inferior to crf.
+# TODO: deprecate PRX_drag_gaussian

{iqm_pulse-10.3.0 → iqm_pulse-10.4.0/src/iqm_pulse.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-pulse
-Version: 10.3.0
+Version: 10.4.0
 Summary: A Python-based project for providing interface and implementations for control pulses.
 Author-email: IQM Finland Oy <info@meetiqm.com>
 License:                                  Apache License

iqm_pulse-10.4.0/version.txt

@@ -0,0 +1 @@
+10.4.0

iqm_pulse-10.3.0/version.txt

@@ -1 +0,0 @@
-10.3.0