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.

FineSXDragCal

class FineSXDragCal(physical_qubits, calibrations, backend=None, cal_parameter_name='β', auto_update=True)[source]

Fine drag calibration of X gate.

Analysis class reference

ErrorAmplificationAnalysis

Experiment options

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

Options
  • Defined in the class FineDragCal:

    • target_angle (float)

      Default value: 1.5707963267948966
      The target rotation angle of the gate being calibrated. This value is needed for the update rule.
  • Defined in the class BaseCalibrationExperiment:

    • result_index (int)

      Default value: -1
      The index of the result from which to update the calibrations.
    • group (str)

      Default value: "default"
      The calibration group to which the parameter belongs. This will default to the value “default”.
  • Defined in the class FineDrag:

    • repetitions (List[int])

      Default value: [0, 1, 2, 3, 4, …]
      A list of the number of times that Rp - Rm gate sequence is repeated.
    • schedule (ScheduleBlock)

      Default value: None
      The schedule for the plus rotation.
    • gate (Gate)

      Default value: None
      This is the gate such as XGate() that will be in the circuits.
  • 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

Initialization

see class FineDrag for details.

Parameters:
  • physical_qubits (Sequence[int]) – Sequence containing the qubit for which to run the fine drag calibration.

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

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

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

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

Attributes

FineSXDragCal.analysis

Return the analysis instance for the experiment.

FineSXDragCal.backend

Return the backend for the experiment

FineSXDragCal.calibrations

Return the calibrations.

FineSXDragCal.experiment_options

Return the options for the experiment.

FineSXDragCal.experiment_type

Return experiment type.

FineSXDragCal.num_qubits

Return the number of qubits for the experiment.

FineSXDragCal.physical_qubits

Return the device qubits for the experiment.

FineSXDragCal.run_options

Return options values for the experiment run() method.

FineSXDragCal.transpile_options

Return the transpiler options for the run() method.

Methods

FineSXDragCal.circuits()

Create the circuits for the fine DRAG calibration experiment.

FineSXDragCal.config()

Return the config dataclass for this experiment

FineSXDragCal.copy()

Return a copy of the experiment

FineSXDragCal.enable_restless([rep_delay, ...])

Enables a restless experiment by setting the restless run options and the restless data processor.

FineSXDragCal.from_config(config)

Initialize an experiment from experiment config

FineSXDragCal.run([backend, analysis, timeout])

Run an experiment and perform analysis.

FineSXDragCal.set_experiment_options(**fields)

Set the experiment options.

FineSXDragCal.set_run_options(**fields)

Set options values for the experiment run() method.

FineSXDragCal.set_transpile_options(**fields)

Add a warning message.

FineSXDragCal.update_calibrations(...)

Update the drag parameter of the pulse in the calibrations.