iqm-pulse 12.5.0__tar.gz → 12.7.0__tar.gz

{iqm_pulse-12.5.0 → iqm_pulse-12.7.0}/CHANGELOG.rst

@@ -1,6 +1,30 @@
-=========
-Changelog
-=========
+Version 12.7.0 (2025-11-19)
+===========================
+
+Features
+--------
+
+- Playlist generation now does acq discovery
+- Add ``Fast_Measure_CustomWaveForms`` and ``Fast_Measure_Constant`` measure implementations that block the locus qubit
+  drive and flux channels only for the duration of the physical probe pulse (plus additional calibratable dead time to
+  account for e.g. ring-down delay).
+- The implementation ``Fast_Measure_CustomWaveForms`` is simplified such that it no longer requires additional virtual
+  probe channels.
+
+Bug fixes
+---------
+
+- Fix `Fast_Measure_CustomWaveForms` not being scheduled correctly in some cases involving deep TimeBox structures.
+- Fix `Fast_Measure_CustomWaveForms.time_trace` which was broken.
+
+Version 12.6.0 (2025-10-23)
+===========================
+
+Features
+--------
+
+- ``cc_prx`` gate now supports ``prx`` gate implementations that consists of multiple drive IQ pulses,
+  e.g. ones that use the ``sx`` gate. As a result, the ``reset`` operation now also works with them.
 
 Version 12.5.0 (2025-10-09)
 ===========================
@@ -336,7 +360,7 @@ Version 8.13.0 (2025-04-07)
 Features
 --------
 
-- Fix package version in published docs footers, :issue:`SW-1392`. 
+- Fix package version in published docs footers, :issue:`SW-1392`.
 
 Version 8.12.0 (2025-04-03)
 ===========================
@@ -369,7 +393,7 @@ Version 8.9.0 (2025-03-28)
 Features
 --------
 
-- Reworked the way default gates (operations) are defined so they are decoupled from their implementations. This separation allows for the deletion of default implementations without losing information about its designated name. 
+- Reworked the way default gates (operations) are defined so they are decoupled from their implementations. This separation allows for the deletion of default implementations without losing information about its designated name.
 - The majority of the original functionality stays the same.
 - The ``register_implementation`` function has been split into several different functions to improve readability and testing, as seen below::
 
@@ -381,8 +405,8 @@ Features
                                                                                     v
                                                                           ``validate_implementation`` --> ``set_default``
 
-- The ``build_quantum_ops`` function in builder.py has been split into several functions as well. 
-- Trying to modify the implementation class of an existing or default gate implementation yields an error. 
+- The ``build_quantum_ops`` function in builder.py has been split into several functions as well.
+- Trying to modify the implementation class of an existing or default gate implementation yields an error.
 
 
 
@@ -1187,7 +1211,7 @@ Version 1.5 (2024-07-05)
 
 Features
 --------
-- Bump exa-common to 25.3 
+- Bump exa-common to 25.3
 
 
 Version 1.4 (2024-07-04)

iqm_pulse-12.7.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include version.txt
+include LICENSE.txt
+prune tests/*
+exclude .gitlab-ci.yml

{iqm_pulse-12.5.0/src/iqm_pulse.egg-info → iqm_pulse-12.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-pulse
-Version: 12.5.0
+Version: 12.7.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
@@ -204,7 +204,7 @@ License:                                  Apache License
            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.
-Project-URL: Documentation, https://iqm-finland.github.io/docs/iqm-pulse/
+Project-URL: Documentation, https://docs.meetiqm.com/iqm-pulse/
 Project-URL: Homepage, https://pypi.org/project/iqm-pulse/
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python :: 3 :: Only
@@ -213,7 +213,6 @@ Classifier: Intended Audience :: Science/Research
 Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
-Requires-Dist: iqm-exa-common<28,>=27
 Requires-Dist: iqm-data-definitions<3.0,>=2.18
 Requires-Dist: python-rapidjson==1.20
 Requires-Dist: jinja2==3.0.3
@@ -226,7 +225,7 @@ IQM Pulse library
 
 A Python-based project for providing interface and implementations for control pulses.
 
-See `API documentation <https://iqm-finland.github.io/docs/iqm-pulse/>`_.
+See `API documentation <https://docs.meetiqm.com/iqm-pulse/>`_.
 
 Copyright
 ---------

{iqm_pulse-12.5.0 → iqm_pulse-12.7.0}/README.rst

@@ -3,7 +3,7 @@ IQM Pulse library
 
 A Python-based project for providing interface and implementations for control pulses.
 
-See `API documentation <https://iqm-finland.github.io/docs/iqm-pulse/>`_.
+See `API documentation <https://docs.meetiqm.com/iqm-pulse/>`_.
 
 Copyright
 ---------

iqm_pulse-12.7.0/docs/changelog.rst

@@ -0,0 +1,8 @@
+.. _changelog:
+
+=========
+CHANGELOG
+=========
+
+.. include:: ../CHANGELOG.rst
+   :literal:

{iqm_pulse-12.5.0 → iqm_pulse-12.7.0}/pyproject.toml

@@ -1,4 +1,3 @@
-# This file is managed by monotool.py, do not edit by hand
 [build-system]
 build-backend = "setuptools.build_meta"
 requires = [ "setuptools", "setuptools_scm[toml]",]
@@ -18,7 +17,7 @@ email = "info@meetiqm.com"
 file = "LICENSE.txt"
 
 [project.urls]
-Documentation = "https://iqm-finland.github.io/docs/iqm-pulse/"
+Documentation = "https://docs.meetiqm.com/iqm-pulse/"
 Homepage = "https://pypi.org/project/iqm-pulse/"
 
 [tool.mypy]
@@ -57,7 +56,7 @@ nb_diff_ignore = [ "/metadata/language_info", "/metadata/widgets", "/cells/*/exe
 
 [tool.ruff.lint]
 ignore = [ "D203", "D213",]
-select = [ "E4", "E7", "E9", "E5", "F", "Q", "PL", "I", "D", "UP007", "UP006", "UP035", "ANN001", "ANN201", "ANN202",]
+select = [ "E4", "E7", "E9", "E5", "F", "Q", "PL", "I", "D", "UP007", "UP006", "UP035", "ANN001", "ANN201", "ANN202", "NPY201",]
 unfixable = [ "F401",]
 
 [tool.ruff.lint.isort]
@@ -68,10 +67,10 @@ known-third-party = [ "exa", "iqm",]
 relative-imports-order = "closest-to-furthest"
 
 [tool.ruff.lint.per-file-ignores]
-"**/__init__.py" = [ "F401", "PLR0402",]
+"**/__init__.py" = [ "D104", "F401", "PLR0402",]
 "**/docs/*" = [ "E402", "D100",]
 "**/setup.py" = [ "D100", "D103", "I001", "ANN201",]
-"**/src/*" = [ "PLR2004", "D400", "D415", "D205", "D401", "D417", "D100", "D101", "D107", "D102", "D105", "D103", "D404", "D104",]
+"**/src/*" = [ "PLR2004", "D400", "D415", "D205", "D401", "D417", "D100", "D107", "D105", "D102", "D404",]
 "**/tests/*" = [ "F632", "PLR2004", "PLR0402", "PLC0414", "D", "ANN001", "ANN201", "ANN202",]
 
 [tool.ruff.lint.pylint]

{iqm_pulse-12.5.0 → iqm_pulse-12.7.0}/requirements/base.txt

@@ -1,7 +1,7 @@
-iqm-exa-common>=27,<28
 iqm-data-definitions >= 2.18, < 3.0
 python-rapidjson == 1.20
 jinja2 == 3.0.3
 numpy >= 1.26.4,<3.0
 scipy >= 1.11.4,<1.16
-scipy-stubs
+scipy-stubs
+

{iqm_pulse-12.5.0 → iqm_pulse-12.7.0}/src/iqm/pulse/builder.py

@@ -15,8 +15,7 @@
 
 from __future__ import annotations
 
-from collections import defaultdict
-from collections.abc import Iterable
+from collections.abc import Iterable, Sequence
 import copy
 from dataclasses import dataclass, field, replace
 import itertools
@@ -56,6 +55,7 @@ from iqm.pulse.playlist.instructions import (
     Instruction,
     IQPulse,
     MultiplexedIQPulse,
+    ReadoutMetrics,
     ReadoutTrigger,
     RealPulse,
     ThresholdStateDiscrimination,
@@ -492,6 +492,10 @@ class ScheduleBuilder:
         """Probe line channel for the probe line ``component`` belongs to.
 
         See :meth:`.get_drive_channel`.
+
+        Args:
+            component: name of a QPU component (typically qubit) to probe
+
         """
         probe_line = self.chip_topology.component_to_probe_line.get(component, None)
         if probe_line is None:
@@ -1038,7 +1042,7 @@ class ScheduleBuilder:
 
     def timeboxes_to_front_padded_playlist(
         self, boxes: Iterable[TimeBox], *, neighborhood: int = 0
-    ) -> tuple[Playlist, dict[str, set[str]]]:
+    ) -> tuple[Playlist, ReadoutMetrics]:
         """Temporary helper function, for converting a sequence of TimeBoxes to a Playlist.
 
         Each individual TimeBox in ``boxes`` is resolved into a Schedule, and then
@@ -1057,8 +1061,7 @@ class ScheduleBuilder:
                 blocks only the defined locus components and any other components which have occupied channels.
 
         Returns:
-            playlist that implements ``boxes`` and the mapping from readout labels to the set of used measurement
-            implementations (of the format ``<QuantumOp name>.<impl name>``).
+            playlist that implements ``boxes`` and the readout metrics for that playlist.
 
         """
         schedules = [self.resolve_timebox(box, neighborhood=neighborhood).cleanup() for box in boxes]
@@ -1102,7 +1105,7 @@ class ScheduleBuilder:
             playlist that implements ``boxes``
 
         """
-        return self.build_playlist(self.timebox_to_schedule(box, neighborhood=neighborhood) for box in boxes)[0]
+        return self.build_playlist([self.timebox_to_schedule(box, neighborhood=neighborhood) for box in boxes])[0]
 
     def timebox_to_schedule(
         self,
@@ -1453,8 +1456,8 @@ class ScheduleBuilder:
                 schedule.append(ch, Block(T))
 
     def build_playlist(  # noqa: PLR0915
-        self, schedules: Iterable[Schedule], finish_schedules: bool = True
-    ) -> tuple[Playlist, dict[str, set[str]]]:
+        self, schedules: Sequence[Schedule], finish_schedules: bool = True
+    ) -> tuple[Playlist, ReadoutMetrics]:
         """Build a playlist from a number of instruction schedules.
 
         This involves compressing the schedules so that no duplicate information
@@ -1468,8 +1471,7 @@ class ScheduleBuilder:
                 unless some process has already finalised them before calling this function.
 
         Returns:
-            playlist containing the schedules and the mapping from readout labels to the set of used measurement
-            implementations (of the format ``<QuantumOp name>.<impl name>``).
+            playlist containing the schedules and the readout metrics for this playlist.
 
         Raises:
             ValueError: if the schedules contain channels with non-uniform sampling rates
@@ -1492,6 +1494,7 @@ class ScheduleBuilder:
 
         pl = Playlist()
         mapped_instructions: dict[str, dict[int | Instruction, Any]] = {}
+        readout_metrics = ReadoutMetrics(num_segments=len(schedules))
 
         def _append_to_schedule(sc_schedule: SC_Schedule, channel_name: str, instr: Instruction) -> None:
             """Append ``instr`` to ``sc_schedule`` into the channel``channel_name``."""
@@ -1517,15 +1520,15 @@ class ScheduleBuilder:
 
                 # add the schedules in the playlist
 
-        label_to_implementation: dict[str, set[str]] = defaultdict(set)
-
         def _map_instruction(inst: Instruction) -> sc_instructions.Instruction:
             """TODO only necessary until SC has been updated to use the iqm.pulse Instruction class."""
             operation: Any
 
             def _map_acquisition(acq: AcquisitionMethod) -> sc_instructions.AcquisitionMethod:
-                if acq.implementation is not None:
-                    label_to_implementation[acq.label].add(acq.implementation)
+                if isinstance(acq, TimeTrace):
+                    return sc_instructions.TimeTrace(
+                        label=acq.label, delay_samples=acq.delay_samples, duration_samples=acq.duration_samples
+                    )
                 if isinstance(acq, ThresholdStateDiscrimination):
                     return sc_instructions.ThresholdStateDiscrimination(
                         label=acq.label,
@@ -1540,10 +1543,7 @@ class ScheduleBuilder:
                         delay_samples=acq.delay_samples,
                         weights=_map_instruction(acq.weights).operation,
                     )
-                if isinstance(acq, TimeTrace):
-                    return sc_instructions.TimeTrace(
-                        label=acq.label, delay_samples=acq.delay_samples, duration_samples=acq.duration_samples
-                    )
+
                 raise ValueError(f"Unknown AcquisitionMethod {acq}")
 
             if isinstance(inst, Wait):
@@ -1587,7 +1587,7 @@ class ScheduleBuilder:
             return sc_instructions.Instruction(duration_samples=int(inst.duration), operation=operation)
 
         # NOTE that there is no implicit right-alignment or equal duration for schedules, unlike in old-style playlists!
-        for schedule in schedules:
+        for seg_idx, schedule in enumerate(schedules):
             finished_schedule = self._finish_schedule(schedule) if finish_schedules else schedule
             sc_schedule = SC_Schedule()
             for channel_name, segment in finished_schedule.items():
@@ -1596,6 +1596,8 @@ class ScheduleBuilder:
                 pl.add_channel(channel)
                 prev_wait = None
                 for instruction in segment:
+                    if isinstance(instruction, ReadoutTrigger):
+                        readout_metrics.extend(instruction, seg_idx)
                     # convert all NONSOLID instructions into Waits
                     if finish_schedules and (isinstance(instruction, NONSOLID) or isinstance(instruction, Wait)):
                         if instruction.duration > 0:
@@ -1614,7 +1616,7 @@ class ScheduleBuilder:
                 if prev_wait:
                     _append_to_schedule(sc_schedule, channel_name, prev_wait)
             pl.segments.append(sc_schedule)
-        return pl, label_to_implementation
+        return pl, readout_metrics
 
     def _set_gate_implementation_shortcut(self, op_name: str) -> None:
         """Create shortcut for `self.get_implementation(<op_name>, ...)` as `self.<op_name>(...)`.

{iqm_pulse-12.5.0 → iqm_pulse-12.7.0}/src/iqm/pulse/gate_implementation.py

@@ -602,7 +602,7 @@ class SinglePulseGate(GateImplementation):
         return self.builder.channels[self.channel].duration_to_seconds(self.pulse.duration)
 
 
-def init_subclass_composite(gate_class: type[CompositeGate]) -> None:
+def init_subclass_composite(gate_class: type[CompositeGate]) -> None:  # noqa: D103
     if not gate_class.registered_gates:
         # this would be pointless
         raise ValueError(f"CompositeGate {gate_class.__name__} has no registered gates.")

{iqm_pulse-12.5.0 → iqm_pulse-12.7.0}/src/iqm/pulse/gates/__init__.py

@@ -49,7 +49,12 @@ from iqm.pulse.gates.cz import (
 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
+from iqm.pulse.gates.measure import (
+    Fast_Measure_Constant,
+    Measure_Constant,
+    Measure_Constant_Qnd,
+    Shelved_Measure_Constant,
+)
 from iqm.pulse.gates.move import MOVE_CRF_CRF, MOVE_SLEPIAN_CRF, MOVE_TGSS_CRF
 from iqm.pulse.gates.prx import (
     Constant_PRX_with_smooth_rise_fall,
@@ -105,6 +110,7 @@ _exposed_implementations: dict[str, type[GateImplementation]] = {
         FluxPulseGate_CRF_CRF,
         Measure_Constant,
         Measure_Constant_Qnd,
+        Fast_Measure_Constant,
         Shelved_Measure_Constant,
         PRX_ModulatedDRAGCosineRiseFall,
         MOVE_CRF_CRF,

{iqm_pulse-12.5.0 → iqm_pulse-12.7.0}/src/iqm/pulse/gates/conditional.py

@@ -18,10 +18,10 @@ import numpy as np
 from exa.common.data.parameter import CollectionType, Parameter
 from iqm.pulse.gate_implementation import CompositeGate
 from iqm.pulse.gates.measure import FEEDBACK_KEY
-from iqm.pulse.gates.prx import PRX_SinglePulse_GateImplementation
-from iqm.pulse.playlist.instructions import Block, ConditionalInstruction, Wait
+from iqm.pulse.playlist.instructions import Block, ConditionalInstruction, IQPulse, Wait
 from iqm.pulse.playlist.schedule import Schedule
 from iqm.pulse.timebox import TimeBox
+from iqm.pulse.utils import fuse_iq_pulses
 
 
 class CCPRX_Composite(CompositeGate):
@@ -30,6 +30,12 @@ class CCPRX_Composite(CompositeGate):
     Applies a PRX gate conditioned on a discriminated readout result obtained in the same segment (active feedback).
     Applies a PRX gate if the result is 1, and a Wait of equal duration if the result is 0.
     Uses the default implementation of PRX underneath, so no extra calibration is needed.
+
+    .. note::
+
+       Assumes that the PRX gate implementation used only consists of IQPulse instructions on the drive channel
+       of its locus qubit.
+
     """
 
     registered_gates = ("prx",)
@@ -70,30 +76,43 @@ class CCPRX_Composite(CompositeGate):
 
         """
         qubit = self.locus[0]
-        awg_name = self.builder.get_drive_channel(qubit)
+        drive_channel = self.builder.get_drive_channel(qubit)
+        prx_gate = self.build("prx", self.locus)
+
+        # NOTE assumes that the PRX gate only has IQPulse instructions on drive_channel
+        timebox: TimeBox = prx_gate(angle, phase)  # type: ignore[assignment]
+        if not timebox.atom:
+            raise RuntimeError("Received non-atomic PRX timebox.")
+        prx_instructions = timebox.atom[drive_channel]
+        iq_pulses = [inst for inst in prx_instructions if isinstance(inst, IQPulse)]
+        if len(iq_pulses) != len(prx_instructions):
+            raise RuntimeError(f"PRX drive channel has non-IQPulse instructions: {prx_instructions}")
+
+        if len(iq_pulses) > 1:
+            iq_pulse = fuse_iq_pulses(iq_pulses)
+        else:
+            iq_pulse = iq_pulses[0]
 
-        prx_gate: PRX_SinglePulse_GateImplementation = self.build("prx", self.locus)  # type: ignore[assignment]
-        # FIXME assumes PRX gates only use this one implementation as the default,
-        # with just a drive channel and a single IQPulse.
-        pulse = prx_gate(angle, phase).atom[prx_gate.channel][0]  # type: ignore[union-attr,index]
-        wait = Wait(pulse.duration)  # idling, can be replaced with a DD sequence later on
+        wait = Wait(iq_pulse.duration)  # idling, can be replaced with a DD sequence later on
 
         # TODO: use the actual inputted label when the HW supports many labels per drive channel
         default_label = f"{feedback_qubit}__{FEEDBACK_KEY}"
-        pulse_instruction = ConditionalInstruction(
-            duration=pulse.duration, condition=default_label, outcomes=(wait, pulse)
+        conditional_instruction = ConditionalInstruction(
+            duration=iq_pulse.duration,
+            condition=default_label,
+            outcomes=(wait, iq_pulse),
         )
         delays = self.calibration_data["control_delays"]
         if len(delays) == 0:
             raise ValueError(f"'control_delays' for '{self.name}' on {qubit} is empty (not calibrated).")
 
-        possible_sources = [c for c in self.builder.get_virtual_feedback_channels(qubit) if awg_name in c]
+        possible_sources = [c for c in self.builder.get_virtual_feedback_channels(qubit) if drive_channel in c]
         if len(delays) != len(possible_sources):
             raise ValueError(
                 f"Not the correct amount of calibration values for 'control_delays'. Need {len(possible_sources)}"
                 f"values, got {delays}."
             )
-        virtual_channel_name = self.builder.get_virtual_feedback_channel_for(awg_name, feedback_qubit)
+        virtual_channel_name = self.builder.get_virtual_feedback_channel_for(drive_channel, feedback_qubit)
         delay = delays[possible_sources.index(virtual_channel_name)]
         virtual_channel = self.builder.channels[virtual_channel_name]
         delay_samples = virtual_channel.duration_to_int_samples(
@@ -106,7 +125,7 @@ class CCPRX_Composite(CompositeGate):
         )
         delay_box.neighborhood_components = {0: {virtual_channel_name}}
         cond = TimeBox.atomic(
-            Schedule({virtual_channel_name: [Block(0)], prx_gate.channel: [pulse_instruction]}),
+            Schedule({virtual_channel_name: [Block(0)], drive_channel: [conditional_instruction]}),
             locus_components=[qubit],
             label=f"Conditional PRX for {qubit}",
         )

{iqm_pulse-12.5.0 → iqm_pulse-12.7.0}/src/iqm/pulse/gates/default_gates.py

@@ -38,7 +38,11 @@ from iqm.pulse.gates.cz import (
 )
 from iqm.pulse.gates.delay import Delay
 from iqm.pulse.gates.flux_multiplexer import FluxMultiplexer_SampleLinear
-from iqm.pulse.gates.measure import Measure_Constant, Shelved_Measure_Constant
+from iqm.pulse.gates.measure import (
+    Fast_Measure_Constant,
+    Measure_Constant,
+    Shelved_Measure_Constant,
+)
 from iqm.pulse.gates.move import MOVE_CRF_CRF, MOVE_SLEPIAN_CRF, MOVE_TGSS_CRF
 from iqm.pulse.gates.prx import (
     PRX_DRAGCosineRiseFall,
@@ -68,6 +72,7 @@ _implementation_library: dict[str, dict[str, type[GateImplementation]]] = {
     "delay": {"wait": Delay},
     "measure": {
         "constant": Measure_Constant,
+        "fast_constant": Fast_Measure_Constant,
     },
     "measure_fidelity": {
         "constant": Measure_Constant,