pulse_factories =============== .. py:module:: quantify_scheduler.operations.pulse_factories .. autoapi-nested-parse:: A module containing factory functions for pulses on the quantum-device layer. These factories are used to take a parametrized representation of on a operation and use that to create an instance of the operation itself. Module Contents --------------- Functions ~~~~~~~~~ .. autoapisummary:: quantify_scheduler.operations.pulse_factories.rxy_drag_pulse quantify_scheduler.operations.pulse_factories.rxy_gauss_pulse quantify_scheduler.operations.pulse_factories.phase_shift quantify_scheduler.operations.pulse_factories.composite_square_pulse quantify_scheduler.operations.pulse_factories.rxy_hermite_pulse quantify_scheduler.operations.pulse_factories.nv_spec_pulse_mw .. py:function:: rxy_drag_pulse(amp180: float, motzoi: float, theta: float, phi: float, port: str, duration: float, clock: str, reference_magnitude: quantify_scheduler.operations.pulse_library.ReferenceMagnitude | None = None) -> quantify_scheduler.operations.pulse_library.DRAGPulse Generate a :class:`~.operations.pulse_library.DRAGPulse` that achieves the right rotation angle ``theta`` based on a calibrated pi-pulse amplitude and motzoi parameter based on linear interpolation of the pulse amplitudes. :param amp180: Unitless amplitude of excitation pulse to get the maximum 180 degree theta. :param motzoi: Unitless amplitude of the derivative component, the DRAG-pulse parameter. :param theta: Angle in degrees to rotate around an equatorial axis on the Bloch sphere. :param phi: Phase of the pulse in degrees. :param port: Name of the port where the pulse is played. :param duration: Duration of the pulse in seconds. :param clock: Name of the clock used to modulate the pulse. :param reference_magnitude: Optional scaling value and unit for the unitless amplitude. Uses settings in hardware config if not provided. :type reference_magnitude: :class:`~quantify_scheduler.operations.pulse_library.ReferenceMagnitude`, optional :returns: DRAGPulse operation. .. py:function:: rxy_gauss_pulse(amp180: float, theta: float, phi: float, port: str, duration: float, clock: str, reference_magnitude: quantify_scheduler.operations.pulse_library.ReferenceMagnitude | None = None) -> quantify_scheduler.operations.pulse_library.GaussPulse Generate a Gaussian drive with :class:`~.operations.pulse_library.GaussPulse` that achieves the right rotation angle ``theta`` based on a calibrated pi-pulse amplitude. :param amp180: Unitless amplitude of excitation pulse to get the maximum 180 degree theta. :param theta: Angle in degrees to rotate around an equatorial axis on the Bloch sphere. :param phi: Phase of the pulse in degrees. :param port: Name of the port where the pulse is played. :param duration: Duration of the pulse in seconds. :param clock: Name of the clock used to modulate the pulse. :param reference_magnitude: Optional scaling value and unit for the unitless amplitude. Uses settings in hardware config if not provided. :type reference_magnitude: :class:`~quantify_scheduler.operations.pulse_library.ReferenceMagnitude`, optional :returns: GaussPulse operation. .. py:function:: phase_shift(theta: float, clock: str) -> quantify_scheduler.operations.pulse_library.ShiftClockPhase Generate a :class:`~.operations.pulse_library.ShiftClockPhase` that shifts the phase of the ``clock`` by an angle `theta`. :param theta: Angle to shift the clock by, in degrees. :param clock: Name of the clock to shift. :returns: ShiftClockPhase operation. .. py:function:: composite_square_pulse(square_amp: float, square_duration: float, square_port: str, square_clock: str, virt_z_parent_qubit_phase: float, virt_z_parent_qubit_clock: str, virt_z_child_qubit_phase: float, virt_z_child_qubit_clock: str, reference_magnitude: quantify_scheduler.operations.pulse_library.ReferenceMagnitude | None = None, t0: float = 0) -> quantify_scheduler.operations.pulse_library.SquarePulse An example composite pulse to implement a CZ gate. It applies the square pulse and then corrects for the phase shifts on both the qubits. :param square_amp: Amplitude of the square envelope. :param square_duration: The square pulse duration in seconds. :param square_port: Port of the pulse, must be capable of playing a complex waveform. :param square_clock: Clock used to modulate the pulse. :param virt_z_parent_qubit_phase: The phase shift in degrees applied to the parent qubit. :param virt_z_parent_qubit_clock: The clock of which to shift the phase applied to the parent qubit. :param virt_z_child_qubit_phase: The phase shift in degrees applied to the child qubit. :param virt_z_child_qubit_clock: The clock of which to shift the phase applied to the child qubit. :param reference_magnitude: Scaling value and unit for the unitless amplitude. Uses settings in hardware config if not provided. :type reference_magnitude: :class:`~quantify_scheduler.operations.pulse_library.ReferenceMagnitude`, optional :param t0: Time in seconds when to start the pulses relative to the start time of the Operation in the Schedule. :returns: SquarePulse operation. .. py:function:: rxy_hermite_pulse(amp180: float, skewness: float, theta: float, phi: float, port: str, duration: float, clock: str, reference_magnitude: quantify_scheduler.operations.pulse_library.ReferenceMagnitude | None = None) -> quantify_scheduler.operations.pulse_library.SkewedHermitePulse Generate a Gaussian drive with :class:`~.operations.pulse_library.GaussPulse` that achieves the right rotation angle ``theta`` based on a calibrated pi-pulse amplitude. :param amp180: Unitless amplitude of excitation pulse to get the maximum 180 degree theta. :param skewness: First-order amplitude correction to the Hermite pulse. Skewness of 0 returns a standard hermite pulse. :param theta: Angle in degrees to rotate around an equatorial axis on the Bloch sphere. :param phi: Phase of the pulse in degrees. :param port: Name of the port where the pulse is played. :param duration: Duration of the pulse in seconds. :param clock: Name of the clock used to modulate the pulse. :param reference_magnitude: Optional scaling value and unit for the unitless amplitude. Uses settings in hardware config if not provided. :type reference_magnitude: :class:`~quantify_scheduler.operations.pulse_library.ReferenceMagnitude`, optional :returns: GaussPulse operation. .. py:function:: nv_spec_pulse_mw(duration: float, amplitude: float, clock: str, port: str, reference_magnitude: quantify_scheduler.operations.pulse_library.ReferenceMagnitude | None = None) -> quantify_scheduler.operations.pulse_library.SkewedHermitePulse Generate hermite pulse for spectroscopy experiment. This is a simplified version of the SkewedHermitePulse. It is not skewed. It also sets the phase to 0. This means that no rotation about the z-axis is applied on the qubit. :param duration: Pulse duration in seconds :param amplitude: Amplitude of the hermite pulse :param skewness: Skewness of hermite pulse :param clock: Name of clock for frequency modulation of hermite pulse :param port: Name of port where hermite pulse is applied :param reference_magnitude: Scaling value and unit for the unitless amplitude. Uses settings in hardware config if not provided. :type reference_magnitude: :class:`~quantify_scheduler.operations.pulse_library.ReferenceMagnitude`, optional :returns: Hermite pulse operation