iqm-pulse 12.4.0__py3-none-any.whl → 12.6.1__py3-none-any.whl

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/gates/measure.py

@@ -871,7 +871,9 @@ class ShelvedMeasureTimeBox(TimeBox):
         return super().__add__(other)
 
     def __radd__(self, other: TimeBox | Iterable[TimeBox]) -> TimeBox:
-        return self.__add__(other)
+        if isinstance(other, MultiplexedProbeTimeBox):
+            return self.__add__(other)  # this commutes
+        return super().__radd__(other)
 
 
 SHELVED_OFFSET_TOLERANCE = 1e-12

iqm/pulse/playlist/waveforms.py

@@ -515,16 +515,13 @@ class ModulatedCosineRiseFall(Waveform):
 
 @dataclass(frozen=True)
 class CosineRise(Waveform):
-    r"""Cosine Rise waveform.
+    r"""Cosine rise waveform.
 
-    This waveform assumes that during its duration, the only thing happening is signal occurring to the required
+    This waveform assumes that during its duration, the only thing happening is signal rising to the required
     amplitude.
     The waveform is made for pairing with 'Constant' waveform to enable arbitrarily long pulses with smooth rise part.
     The rise time is equal to pulse duration.
 
-    Args:
-        rise_time: Dummy parameter, used only as due to a bug. FIXME it is not used, placed for resolving exa bug
-
     """
 
     def _sample(self, sample_coords: np.ndarray) -> np.ndarray:
@@ -533,7 +530,7 @@ class CosineRise(Waveform):
 
 @dataclass(frozen=True)
 class CosineFall(Waveform):
-    r"""Cosine Rise waveform.
+    r"""Cosine fall waveform.
 
     This waveform assumes that during its duration, the only thing occurring is signal falling to 0.
     The waveform is made for pairing with 'Constant' waveform to enable arbitrarily long pulses with smooth fall part.

iqm/pulse/timebox.py

@@ -210,6 +210,19 @@ class TimeBox:
             raise ValueError(f"Tried to access a child of {self}, which is atomic.")
         return self.children[item]
 
+    def _add_children(self, other: TimeBox) -> TimeBox:
+        """Concat the children of self and other together."""
+        left = self.children if self.atom is None else (self,)
+        right = other.children if other.atom is None else (other,)
+        return TimeBox(
+            label=self.label,
+            locus_components=self.locus_components.union(other.locus_components),
+            atom=None,
+            children=left + right,
+            scheduling=self.scheduling,
+            scheduling_algorithm=self.scheduling_algorithm,
+        )
+
     def __add__(self, other: TimeBox | Iterable[TimeBox]) -> TimeBox:
         """Return a new TimeBox which has the contents of this and another TimeBox concatenated.
 
@@ -231,16 +244,7 @@ class TimeBox:
             # allow subclasses to override __add__ such that __radd__ also works consistent with that logic
             return other.__radd__(self)  # type: ignore[union-attr]
         if isinstance(other, TimeBox):
-            left = self.children if self.atom is None else (self,)
-            right = other.children if other.atom is None else (other,)
-            return TimeBox(
-                label=self.label,
-                locus_components=self.locus_components.union(other.locus_components),
-                atom=None,
-                children=left + right,
-                scheduling=self.scheduling,
-                scheduling_algorithm=self.scheduling_algorithm,
-            )
+            return self._add_children(other)
         try:
             return reduce(lambda x, y: x + y, other, self)
         except TypeError as err:
@@ -248,7 +252,7 @@ class TimeBox:
 
     def __radd__(self, other: TimeBox | Iterable[TimeBox]) -> TimeBox:
         if isinstance(other, TimeBox):
-            return self.__add__(other)
+            return other._add_children(self)
         it = iter(other)
         try:
             first = next(it)
@@ -397,6 +401,3 @@ class MultiplexedProbeTimeBox(TimeBox):
             scheduling_algorithm=SchedulingAlgorithm.HARD_BOUNDARY,
         )
         return box
-
-    def __radd__(self, other: TimeBox | Iterable[TimeBox]) -> TimeBox:
-        return self.__add__(other)

iqm/pulse/utils.py

@@ -17,11 +17,15 @@
 
 from __future__ import annotations
 
+from collections.abc import Iterable
+from dataclasses import replace
 from typing import get_args, get_origin
 
 import numpy as np
 
 from exa.common.data.parameter import CollectionType, DataType
+from iqm.pulse.playlist import IQPulse
+from iqm.pulse.playlist.waveforms import Samples
 
 
 def map_waveform_param_types(type_hint: type) -> tuple[DataType, CollectionType]:
@@ -107,3 +111,85 @@ def phase_transformation(psi_1: float = 0.0, psi_2: float = 0.0) -> tuple[float,
 
     """
     return psi_2, -(psi_1 + psi_2)
+
+
+def modulate_iq(pulse: IQPulse) -> np.ndarray:
+    """Sampled baseband waveform of an IQ pulse.
+
+    Note that :attr:`IQPulse.phase_increment` has no effect on the sampled waveform.
+    The upconversion oscillator phase incrementation is a separate action performed by the AWG
+    that also affects future IQPulses, and thus cannot be represented by an array of waveform samples.
+    To replicate the effect of ``pulse`` on an AWG, one should first perform the increment and then
+    play the returned samples.
+
+    Args:
+        pulse: IQ pulse.
+
+    Returns:
+        The waveform of ``pulse`` as an array of complex-valued samples.
+
+    """
+    # TODO: Could be an IQPulse method
+    wave = pulse.wave_i.sample() * pulse.scale_i + 1j * pulse.wave_q.sample() * pulse.scale_q
+    # starting times of the samples, in units of inverse sample rate
+    wave_sampletimes = np.arange(len(wave))
+    wave *= np.exp(2j * np.pi * pulse.modulation_frequency * wave_sampletimes + 1j * pulse.phase)
+    return wave
+
+
+def fuse_iq_pulses(iq_pulses: Iterable[IQPulse]) -> IQPulse:
+    """Fuse multiple IQPulses into one by concatenating the sampled waveforms.
+
+    Works by flushing :attr:`IQPulse.phase_increment` s to the front, updating the :attr:`IQPulse.phase` s,
+    sampling the pulses, concatenating, normalizing the amplitudes, and putting the result
+    into a new IQPulse instruction with a ``phase_increment`` that is a sum of the individual ``phase_increment`` s.
+
+    Additionally, to conserve waveform memory on the AWGs, we normalize the waveform phase by setting
+    :attr:`IQPulse.phase` of the fused pulse to the flushed phase of the first pulse.
+
+    Args:
+        iq_pulses: IQPulse instructions to fuse.
+
+    Returns:
+        Fused IQPulse that behaves indentically to the sequence ``iq_pulses`` on an AWG.
+
+    """
+    # flush the phase increments to the start of the pulse sequence
+    phases = np.array([i.phase for i in iq_pulses])
+    phase_increments = np.array([i.phase_increment for i in iq_pulses])
+
+    # flushed_phases[k] == phases[k] - np.sum(phase_increments[k+1:])
+    flushed_phases = phases - np.cumsum(phase_increments[::-1])[::-1] + phase_increments
+
+    # Phase normalization of the samples to save waveform memory: There is an internal degree of freedom
+    # in the sampled IQPulse: IQPulse.phase can be represented in the global phase of the samples.
+    # Fix this d.o.f. by setting the phase of the fused IQ pulse to the phase of the first constituent IQ pulse.
+    fused_phase = flushed_phases[0]
+    flushed_phases -= fused_phase
+    flushed_iq_pulses = [
+        replace(instr, phase=phase, phase_increment=0.0) for instr, phase in zip(iq_pulses, flushed_phases)
+    ]
+    # sample and concatenate the IQ pulses
+    samples = np.hstack([modulate_iq(i) for i in flushed_iq_pulses])
+
+    # normalize the real and imaginary waveform components
+    def normalize(samples: np.ndarray) -> tuple[np.ndarray, float]:
+        """Normalize real-valued samples to [-1, 1]."""
+        scale = np.max(np.abs(samples))
+        # avoid division by zero
+        if scale > 0:
+            return samples / scale, scale
+        return samples, 1.0
+
+    samples.real, scale_i = normalize(samples.real)
+    samples.imag, scale_q = normalize(samples.imag)
+    return IQPulse(
+        duration=len(samples),
+        wave_i=Samples(samples.real),
+        wave_q=Samples(samples.imag),
+        scale_i=scale_i,
+        scale_q=scale_q,
+        phase=fused_phase,
+        phase_increment=np.sum(phase_increments),
+        modulation_frequency=0.0,  # modulate_iq takes care of this
+    )

{iqm_pulse-12.4.0.dist-info → iqm_pulse-12.6.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-pulse
-Version: 12.4.0
+Version: 12.6.1
 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-12.4.0.dist-info → iqm_pulse-12.6.1.dist-info}/RECORD

@@ -6,18 +6,18 @@ iqm/pulse/gate_implementation.py,sha256=nyoP54-VWKx9rO8MW5ZqCRPjsMTKfJFu_6cgabxJ
 iqm/pulse/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 iqm/pulse/quantum_ops.py,sha256=cV13V1t2rj9lgNKXgGZXMcNgEPJ7oraHL6eJJTlLvWk,14825
 iqm/pulse/scheduler.py,sha256=62gH3AcxmsgmShcmtNaiCqFLRl1Wll6Q24zIkhw_-XM,22768
-iqm/pulse/timebox.py,sha256=FCwnQRQSrN_9O8obSJ16VXrSbSlg4CSdAPY8K2I8qCo,17226
-iqm/pulse/utils.py,sha256=0J4KQNvKtZahme7sP7vLa1FtENepC-eb9_A5WaghvVU,3710
+iqm/pulse/timebox.py,sha256=VbNgxYsXP-Plx4FAX9b2v_CThJJh9dBzFun3E5jzP7o,17249
+iqm/pulse/utils.py,sha256=UjB5AHgDOj_5nm-Rt6Ql9GJpjV3OrtwpEVzysXhQghY,7466
 iqm/pulse/validation.py,sha256=U392B1QtX2nRNAD2j1eThrim1VH18SNKGYAYUVR9_q4,10781
 iqm/pulse/gates/__init__.py,sha256=l07iD52FiKKQyVFwswRapZMqEE0XfILSc4aZ5sXGJo4,8811
 iqm/pulse/gates/barrier.py,sha256=WhYV70lf4lh4Wa9UZuMk2lp9JbUQIu8lzewRC2P7pNE,2546
-iqm/pulse/gates/conditional.py,sha256=NE-1GYlFcfaCmRuhqGEIhtoJmBArhyY5KhVnO4y4zng,6289
+iqm/pulse/gates/conditional.py,sha256=mY7b4HmznFF5VUAXrbK7tDxCP4n2pASINa3TJHjHA6o,6872
 iqm/pulse/gates/cz.py,sha256=2-LqAMG08dOReQp8K517zTkMmhDfwXhEXPqTPyjppDk,33519
 iqm/pulse/gates/default_gates.py,sha256=JwdrCh_Blee4mMWZ8v8ymw3Ep0fZBvw9wuaLR3rjDXA,8073
 iqm/pulse/gates/delay.py,sha256=nST9dY2JFp_mpKhiSfsYa5yL4hFKcNJSAyCzXjhauQg,3767
 iqm/pulse/gates/enums.py,sha256=ATwb6vZYpfgQ1gQyFPW53JyIKrdAP3FPHm6jV-t9OAk,2532
 iqm/pulse/gates/flux_multiplexer.py,sha256=sk84ItEvkx7Z0pCHt8MCCczBe7_BHNvqS4_oeNghZw8,9757
-iqm/pulse/gates/measure.py,sha256=_ujAxZb4b6NPXSMh7JPgJevMATHOc9oUUdwd0PTLios,51853
+iqm/pulse/gates/measure.py,sha256=3gxMjUvQrum9ZVnm8rvRHqPUQYqOCnD3IsgnrP-vECY,51968
 iqm/pulse/gates/move.py,sha256=siy9SBIFohknYV6zEJuUZv03cDEOiS53p9jFYm-5WAA,17470
 iqm/pulse/gates/prx.py,sha256=gWT4vEL6BZvRNOkwlxSg_V8nq7baFgh2K-V8q3bqLjI,25203
 iqm/pulse/gates/reset.py,sha256=JzUurqhncTQ3Ti9tJyQHSybSXZsGslV0K-Dz5GRliPI,7066
@@ -31,7 +31,7 @@ iqm/pulse/playlist/hd_drag.py,sha256=JYRy3aPu0LD9y0H3UncOiWI39eV9-TARvgLonNUsaO0
 iqm/pulse/playlist/instructions.py,sha256=z9umJqFLTsSd26EuzW-X5raWVHGpSLds9s4m8tDAV-E,10249
 iqm/pulse/playlist/playlist.py,sha256=7MIX4iRfh2Nit8AnpNyqv5A5ZmK7JR-v201DXVL6kUk,685
 iqm/pulse/playlist/schedule.py,sha256=ToaHKgDxNxLUQalI2TAMMld-EH5Im9rZNktQkXhOyBk,18037
-iqm/pulse/playlist/waveforms.py,sha256=rbP87uMjieKTYi6g4Twx_oPiVIDCTcTuWz5LaYhsaCA,24101
+iqm/pulse/playlist/waveforms.py,sha256=w5Kgpo7VJwsaCUUKOu3rf5pNmN7Jw2jVLTn3hH-k0R4,23973
 iqm/pulse/playlist/visualisation/__init__.py,sha256=wCNfJHIR_bqG3ZBlgm55v90Rih7VCpfctoIMfwRMgjk,567
 iqm/pulse/playlist/visualisation/base.py,sha256=qk7oHvMFk7d3ybNwJ7TpZEX8ahxfzB-kVCzqgjKM71Y,8932
 iqm/pulse/playlist/visualisation/templates/playlist_inspection.jinja2,sha256=4XPmpISH5LLOf3YjmK3OKfvkAWj4TlzD2K4ClFTvZhI,11511
@@ -39,8 +39,8 @@ iqm/pulse/playlist/visualisation/templates/static/logo.png,sha256=rbfQZ6_UEaztpY
 iqm/pulse/playlist/visualisation/templates/static/moment.min.js,sha256=4iQZ6BVL4qNKlQ27TExEhBN1HFPvAvAMbFavKKosSWQ,53324
 iqm/pulse/playlist/visualisation/templates/static/vis-timeline-graph2d.min.css,sha256=svzNasPg1yR5gvEaRei2jg-n4Pc3sVyMUWeS6xRAh6U,19837
 iqm/pulse/playlist/visualisation/templates/static/vis-timeline-graph2d.min.js,sha256=OqCqCyA6JnxPz3PGXq_P_9VuSqWptgNt5Ev3T-xjefQ,570288
-iqm_pulse-12.4.0.dist-info/LICENSE.txt,sha256=R6Q7eUrLyoCQgWYorQ8WJmVmWKYU3dxA3jYUp0wwQAw,11332
-iqm_pulse-12.4.0.dist-info/METADATA,sha256=q0rATe2XxoAOfBeOILxcAVWhoCOw_AbJ6VmmG7-gg2Y,14551
-iqm_pulse-12.4.0.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
-iqm_pulse-12.4.0.dist-info/top_level.txt,sha256=NB4XRfyDS6_wG9gMsyX-9LTU7kWnTQxNvkbzIxGv3-c,4
-iqm_pulse-12.4.0.dist-info/RECORD,,
+iqm_pulse-12.6.1.dist-info/LICENSE.txt,sha256=R6Q7eUrLyoCQgWYorQ8WJmVmWKYU3dxA3jYUp0wwQAw,11332
+iqm_pulse-12.6.1.dist-info/METADATA,sha256=YFmqgzW0EOBqKVCAYvmretZ9LwjM8Mq-RHJk7DrivK8,14551
+iqm_pulse-12.6.1.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
+iqm_pulse-12.6.1.dist-info/top_level.txt,sha256=NB4XRfyDS6_wG9gMsyX-9LTU7kWnTQxNvkbzIxGv3-c,4
+iqm_pulse-12.6.1.dist-info/RECORD,,