RZXCalibrationBuilder

class qiskit.transpiler.passes.RZXCalibrationBuilder(*args, **kwargs)

Bases: CalibrationBuilder

Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of qubits) the CX schedule in the instruction schedule map of the backend defaults. The CX schedule must be an echoed cross-resonance gate optionally with rotary tones. The cross-resonance drive tones and rotary pulses must be Gaussian square pulses. The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle. If the rotation angle is small such that the width disappears then the amplitude of the zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation angle. Additional details can be found in https://arxiv.org/abs/2012.11660.

Initializes a RZXGate calibration builder.

Deprecated since version 1.3

The class qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: https://github.com/qiskit-community/qiskit-dynamics. Note that once removed, qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder will have no alternative in Qiskit.

Parameters

instruction_schedule_map – The InstructionScheduleMap object representing the default pulse calibrations for the target backend
verbose – Set True to raise a user warning when RZX schedule cannot be built.
target – The Target representing the target backend, if both instruction_schedule_map and this are specified then this argument will take precedence and instruction_schedule_map will be ignored.

Raises

QiskitError – Instruction schedule map is not provided.

Attributes

is_analysis_pass

Check if the pass is an analysis pass.

If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass.

is_transformation_pass

Check if the pass is a transformation pass.

If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read).

Methods

execute

execute(passmanager_ir, state, callback=None)

GitHub

Execute optimization task for input Qiskit IR.

Parameters

passmanager_ir (Any) – Qiskit IR to optimize.
state (PassManagerState) – State associated with workflow execution by the pass manager itself.
callback (Callable | None) – A callback function which is caller per execution of optimization task.

Returns

Optimized Qiskit IR and state of the workflow.

Return type

tuple[Any, qiskit.passmanager.compilation_status.PassManagerState]

get_calibration

get_calibration(node_op, qubits)

GitHub

Builds the calibration schedule for the RZXGate(theta) with echos.

Parameters

node_op (CircuitInst) – Instruction of the RZXGate(theta). I.e. params[0] is theta.
qubits (list) – List of qubits for which to get the schedules. The first qubit is the control and the second is the target.

Returns

The calibration schedule for the RZXGate(theta).

Return type

schedule

Raises

QiskitError – if rotation angle is not assigned.
QiskitError – If the control and target qubits cannot be identified.
CalibrationNotAvailable – RZX schedule cannot be built for input node.

name

name()

GitHub

Name of the pass.

Return type

str

rescale_cr_inst

static rescale_cr_inst(instruction, theta, sample_mult=16)

GitHub

A builder macro to play stretched pulse.

Parameters

instruction (Play) – The instruction from which to create a new shortened or lengthened pulse.
theta (float) – desired angle, pi/2 is assumed to be the angle that the pulse in the given play instruction implements.
sample_mult (int) – All pulses must be a multiple of sample_mult.

Returns

Duration of stretched pulse.

Raises

QiskitError – if rotation angle is not assigned.

Return type

int