Rabi

class Rabi(qubit, schedule, amplitudes=None, backend=None)

An experiment that scans a pulse amplitude to calibrate rotations between 0 and 1.

Overview

The circuits have a custom rabi gate with the pulse schedule attached to it through the calibrations. The circuits are of the form:

           ┌───────────┐ ░ ┌─┐
      q_0: ┤ Rabi(amp) ├─░─┤M├
           └───────────┘ ░ └╥┘
measure: 1/═════════════════╩═
                            0

The user provides his own schedule for the Rabi at initialization which must have one free parameter, i.e. the amplitude to scan and a drive channel which matches the qubit.

Tutorials

Calibrating single-qubit gates on a real device

See also Qiskit Textbook for the pulse level programming of a Rabi experiment.

Analysis Class Reference

OscillationAnalysis

Experiment Options

These options can be set by set_experiment_options() method.

Parameters:

• amplitudes (iterable) – The list of amplitude values to scan.

• schedule (ScheduleBlock) – The schedule for the Rabi pulse. This schedule must have exactly one free parameter. The drive channel should match the qubit.

Default values

Following values are set by default.

amplitudes                := array([-0.95 , -0.912, -0.874, -0.836, -0.798, -0.76 , -0.722, -0.684,
       -0.646, -0.608, -0.57 , -0.532, -0.494, -0.456, -0.418, -0.38 ,
       -0.342, -0.304, -0.266, -0.228, -0.19 , -0.152, -0.114, -0.076,
       -0.038,  0.   ,  0.038,  0.076,  0.114,  0.152,  0.19 ,  0.228,
        0.266,  0.304,  0.342,  0.38 ,  0.418,  0.456,  0.494,  0.532,
        0.57 ,  0.608,  0.646,  0.684,  0.722,  0.76 ,  0.798,  0.836,
        0.874,  0.912,  0.95 ])
schedule                  := None

Transpiler Options

This option can be set by set_transpile_options() method.

This option is used for circuit optimization. See the documentation of qiskit.transpile for available options.

Default values

Following values are set by default.

optimization_level        := 0

Backend Run Options

This option can be set by set_run_options() method.

This option is used for controlling job execution condition. Note that this option is provider dependent. See provider’s backend runner API for available options. See the documentation of IBMQBackend.run for the IBM Quantum Service.

Default values

Following values are set by default.

meas_level                := <MeasLevel.KERNELED: 1>
meas_return               := 'single'

Initialization

Initialize a Rabi experiment on the given qubit.

Parameters:

• qubit (int) – The qubit on which to run the Rabi experiment.

• schedule (ScheduleBlock) – The schedule that will be used in the Rabi experiment. This schedule should have one free parameter namely the amplitude.

• amplitudes (Optional[Iterable[float]]) – The pulse amplitudes that one wishes to scan. If this variable is not specified it will default to np.linspace(-0.95, 0.95, 51).

• backend (Optional[Backend]) – Optional, the backend to run the experiment on.

Attributes

Rabi.analysis	Return the analysis instance for the experiment
Rabi.analysis_options	Return the analysis options for run() analysis.
Rabi.backend	Return the backend for the experiment
Rabi.experiment_options	Return the options for the experiment.
Rabi.experiment_type	Return experiment type.
Rabi.num_qubits	Return the number of qubits for the experiment.
Rabi.physical_qubits	Return the device qubits for the experiment.
Rabi.run_options	Return options values for the experiment run() method.
Rabi.transpile_options	Return the transpiler options for the run() method.

Methods

Rabi.circuits()	Create the circuits for the Rabi experiment.
Rabi.config()	Return the config dataclass for this experiment
Rabi.copy()	Return a copy of the experiment
Rabi.enable_restless([rep_delay, ...])	Enables a restless experiment by setting the restless run options and the restless data processor.
Rabi.from_config(config)	Initialize an experiment from experiment config
Rabi.run([backend, analysis, timeout])	Run an experiment and perform analysis.
Rabi.set_experiment_options(**fields)	Set the experiment options.
Rabi.set_run_options(**fields)	Set options values for the experiment run() method.
Rabi.set_transpile_options(**fields)	Set the transpiler options for run() method.