Note

This is the documentation for the current state of the development branch of Qiskit Experiments. The documentation or APIs here can change prior to being released.

EFRabi¶

class EFRabi(physical_qubits, schedule, amplitudes=None, backend=None)[source]¶

An experiment that scans the amplitude of a pulse inducing rotations on the \(|1\rangle\) <-> \(|2\rangle\) transition.

Overview

This experiment is a subclass of the Rabi experiment but takes place between the first and second excited state. An initial X gate populates the first excited state. The Rabi pulse is applied on the \(|1\rangle\) <-> \(|2\rangle\) transition (sometimes also labeled the e <-> f transition). The necessary frequency shift (typically the qubit anharmonicity) is given through the pulse schedule given at initialization. The schedule is then also stored in the experiment options. The circuits are of the form:

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

Analysis class reference

OscillationAnalysis

Experiment options

These options can be set by the set_experiment_options() method.

Options

Defined in the class Rabi:
- amplitudes (iterable)
  
  Default value: array(-0.95, -0.9119999999999999, -0.874, -0.836, -0.7979999999999999, ..., size=51)
  
  The list of amplitude values to scan.
- schedule (ScheduleBlock)
  
  Default value: None
  
  The schedule for the Rabi pulse. This schedule must have exactly one free parameter. The drive channel should match the qubit.
Defined in the class BaseExperiment:
- max_circuits (Optional[int])
  
  Default value: None
  
  The maximum number of circuits per job when running an experiment on a backend.

Example

import numpy as np
from qiskit import pulse
from qiskit.circuit import Parameter
from qiskit_experiments.library import EFRabi

with pulse.build() as build_sched:
    with pulse.align_left():
        pulse.shift_frequency(-0.25e9, pulse.DriveChannel(0))
        pulse.play(pulse.Gaussian(160, Parameter("amp"), 40), pulse.DriveChannel(0))

exp = EFRabi(physical_qubits=(0,),
             schedule=build_sched,
             amplitudes=np.linspace(-0.1, 0.1, 21),
             backend=backend,)

exp_data = exp.run().block_for_results()
display(exp_data.figure(0))
exp_data.analysis_results(dataframe=True)

../_images/qiskit_experiments.library.characterization.EFRabi_1_0.png

	name	experiment	components	value	quality	backend	run_time	chisq
c1545b13	@Parameters_OscillationAnalysis	EFRabi	[Q0]	CurveFitResult:\n - fitting method: least_squa...	good	PulseBackendV2	None	None
49bc3d35	rabi_rate_12	EFRabi	[Q0]	6.909+/-0.021	good	PulseBackendV2	None	0.768576