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.

RoughDragCal¶

class RoughDragCal(physical_qubits, calibrations, backend=None, schedule_name='x', betas=None, cal_parameter_name='β', auto_update=True, group='default')[source]¶

A calibration version of the RoughDrag experiment.

User manual

Calibrating the value of the DRAG coefficient

Analysis class reference

DragCalAnalysis

Experiment options

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

Options

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 RoughDrag:
- schedule (ScheduleBlock)
  
  Default value: None
  
  The schedule of the rotation.
- reps (List[int])
  
  Default value: [1, 3, 5]
  
  The number of times the Rp - Rm gate sequence is repeated in each series. Note that this list must always have a length of three as otherwise the analysis class will not run.
- betas (Iterable)
  
  Default value: array(-5.0, -4.8, -4.6, -4.4, -4.2, ..., size=51)
  
  the values of the DRAG parameter to scan.
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 RoughDrag for details.

Parameters:

physical_qubits (Sequence[int]) – Sequence containing the qubit for which to run the rough DRAG calibration.
calibrations (Calibrations) – The calibrations instance with the schedules.
backend (Optional[Backend]) – Optional, the backend to run the experiment on.
schedule_name (str) – The name of the schedule to calibrate. Defaults to “x”.
betas (Optional[Iterable[float]]) – A list of DRAG parameter values to scan. If None is given 51 betas ranging from -5 to 5 will be scanned.
cal_parameter_name (Optional[str]) – The name of the parameter in the schedule to update. Defaults to “β”.
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”.

Attributes

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

Methods

`RoughDragCal.circuits`()	Create the circuits for the Drag calibration.
`RoughDragCal.config`()	Return the config dataclass for this experiment
`RoughDragCal.copy`()	Return a copy of the experiment
`RoughDragCal.enable_restless`([rep_delay, ...])	Enables a restless experiment by setting the restless run options and the restless data processor.
`RoughDragCal.from_config`(config)	Initialize an experiment from experiment config
`RoughDragCal.run`([backend, analysis, timeout])	Run an experiment and perform analysis.
`RoughDragCal.set_experiment_options`(**fields)	Set the experiment options.
`RoughDragCal.set_run_options`(**fields)	Set options values for the experiment `run()` method.
`RoughDragCal.set_transpile_options`(**fields)	Add a warning message.
`RoughDragCal.update_calibrations`(experiment_data)	Update the beta using the value directly reported from the fit.