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.

RoughAmplitudeCal

class RoughAmplitudeCal(physical_qubits, calibrations, schedule_name='x', amplitudes=None, cal_parameter_name='amp', target_angle=3.141592653589793, auto_update=True, group='default', backend=None)

A calibration version of the Rabi experiment.

Analysis class reference

OscillationAnalysis

Experiment options

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

Options

• Defined in the class RoughAmplitudeCal:

  • result_index (int)

    Default value: -1

    The index of the result from which to update the calibrations.

  • angles_schedules (list(float, str, str, float))

    Default value: [(3.141592653589793, "amp", "x", None)]

    A list of parameter update information. Each entry of the list is a tuple with four entries: the target angle of the rotation, the name of the amplitude parameter to update, the name of the schedule containing the amplitude parameter to update, and the previous value of the amplitude parameter to update. This allows one experiment to update several schedules, see for example RoughXSXAmplitudeCal.

  • group (str)

    Default value: "default"

    The calibration group to which the parameter belongs. This will default to the value “default”.

• 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.

See also

• Superclass qiskit_experiments.calibration_management.base_calibration_experiment.BaseCalibrationExperiment

• Superclass qiskit_experiments.library.characterization.rabi.Rabi

Initialization

see class Rabi for details.

Parameters:

• physical_qubits (Sequence[int]) – Sequence containing the qubit for which to run the rough amplitude calibration.

• calibrations (Calibrations) – The calibrations instance with the schedules.

• schedule_name (str) – The name of the schedule to calibrate. Defaults to “x”.

• amplitudes (Optional[Iterable[float]]) – A list of amplitudes to scan. If None is given 51 amplitudes ranging from -0.95 to 0.95 will be scanned.

• cal_parameter_name (Optional[str]) – The name of the parameter in the schedule to update.

• target_angle (float) – The target angle of the gate to calibrate this will default to a $\pi$-pulse.

• auto_update (bool) – Whether or not to automatically update the calibrations. By default this variable is set to True.

• group (str) – The group of calibration parameters to use. The default value is “default”.

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

Attributes

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

Methods

RoughAmplitudeCal.circuits()	Create the circuits for the Rabi experiment.
RoughAmplitudeCal.config()	Return the config dataclass for this experiment
RoughAmplitudeCal.copy()	Return a copy of the experiment
RoughAmplitudeCal.enable_restless([...])	Enables a restless experiment by setting the restless run options and the restless data processor.
RoughAmplitudeCal.from_config(config)	Initialize an experiment from experiment config
RoughAmplitudeCal.run([backend, analysis, ...])	Run an experiment and perform analysis.
RoughAmplitudeCal.set_experiment_options(...)	Set the experiment options.
RoughAmplitudeCal.set_run_options(**fields)	Set options values for the experiment run() method.
RoughAmplitudeCal.set_transpile_options(**fields)	Add a warning message.
RoughAmplitudeCal.update_calibrations(...)	Update the amplitude of one or several schedules.