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.

FineDragCal¶

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

A calibration version of the fine drag experiment.

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: 3.141592653589793
  
  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.

Note that this class implicitly assumes that the target angle of the gate is $π$ as seen from the default experiment options.

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.
schedule_name (str) – The name of the schedule to calibrate.
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

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

Methods

`FineDragCal.circuits`()	Create the circuits for the fine DRAG calibration experiment.
`FineDragCal.config`()	Return the config dataclass for this experiment
`FineDragCal.copy`()	Return a copy of the experiment
`FineDragCal.enable_restless`([rep_delay, ...])	Enables a restless experiment by setting the restless run options and the restless data processor.
`FineDragCal.from_config`(config)	Initialize an experiment from experiment config
`FineDragCal.run`([backend, analysis, timeout])	Run an experiment and perform analysis.
`FineDragCal.set_experiment_options`(**fields)	Set the experiment options.
`FineDragCal.set_run_options`(**fields)	Set options values for the experiment `run()` method.
`FineDragCal.set_transpile_options`(**fields)	Add a warning message.
`FineDragCal.update_calibrations`(experiment_data)	Update the drag parameter of the pulse in the calibrations.