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.

HalfAngleCal

class HalfAngleCal(physical_qubits, calibrations, backend=None, schedule_name='sx', cal_parameter_name='amp', auto_update=True)

Calibration version of the half-angle experiment.

Analysis class reference

ErrorAmplificationAnalysis

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 HalfAngle:

  • repetitions (List[int])

    Default value: [0, 1, 2, 3, 4, …]

    A list of the number of times that the gate sequence [sx sx y] is repeated.

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

Initialization

see class HalfAngle for details.

Parameters:

• physical_qubits (Sequence[int]) – Sequence containing the qubit for which to run the half-angle 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 which defaults to sx.

• cal_parameter_name (Optional[str]) – The name of the parameter in the schedule to update. This will default to amp since the complex amplitude contains the phase of the pulse.

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

Attributes

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

Methods

HalfAngleCal.circuits()	Create the circuits for the half angle calibration experiment.
HalfAngleCal.config()	Return the config dataclass for this experiment
HalfAngleCal.copy()	Return a copy of the experiment
HalfAngleCal.from_config(config)	Initialize an experiment from experiment config
HalfAngleCal.run([backend, analysis, timeout])	Run an experiment and perform analysis.
HalfAngleCal.set_experiment_options(**fields)	Set the experiment options.
HalfAngleCal.set_run_options(**fields)	Set options values for the experiment run() method.
HalfAngleCal.set_transpile_options(**fields)	Add a warning message.
HalfAngleCal.update_calibrations(experiment_data)	Update the value of the parameter in the calibrations.