laboneq_applications.experiments.amplitude_rabi

This module defines the amplitude-rabi experiment.

In this experiment, we sweep the amplitude of a drive pulse on a given qubit transition in order to determine the pulse amplitude that induces a rotation of pi.

The amplitude-rabi experiment has the following pulse sequence:

qb --- [ prep transition ] --- [ x180_transition ] --- [ measure ]

If multiple qubits are passed to the run workflow, the above pulses are applied in parallel on all the qubits.

create_experiment(qpu, qubits, amplitudes, options=None)

Creates an Amplitude Rabi experiment Workflow.

Parameters:

Name	Type	Description	Default
qpu	QPU	The qpu consisting of the original qubits and quantum operations.	required
qubits	QuantumElements	The qubits to run the experiments on. May be either a single qubit or a list of qubits.	required
amplitudes	QubitSweepPoints	The amplitudes to sweep over for each qubit. If qubits is a single qubit, amplitudes must be a list of numbers or an array. Otherwise it must be a list of lists of numbers or arrays.	required
options	TuneupExperimentOptions | None	The options for building the experiment. See [TuneupExperimentOptions] and [BaseExperimentOptions] for accepted options. Overwrites the options from [TuneupExperimentOptions] and [BaseExperimentOptions].	None

Returns:

Name	Type	Description
experiment	Experiment	The generated LabOne Q experiment instance to be compiled and executed.

Raises:

Type	Description
ValueError	If the qubits and qubit_amplitudes are not of the same length.
ValueError	If qubit_amplitudes is not a list of numbers when a single qubit is passed.
ValueError	If qubit_amplitudes is not a list of lists of numbers.
ValueError	If the experiment uses calibration traces and the averaging mode is sequential.

Example

options = {
    "count": 10,
    "transition": "ge",
    "averaging_mode": "cyclic",
    "acquisition_type": "integration_trigger",
    "cal_traces": True,
}
options = TuneupExperimentOptions(**options)
qpu = QPU(
    quantum_elements=[TunableTransmonQubit("q0"), TunableTransmonQubit("q1")],
    quantum_operations=TunableTransmonOperations(),
)
temp_qubits = qpu.copy_quantum_elements()
create_experiment(
    qpu=qpu,
    qubits=temp_qubits,
    amplitudes=[
        np.linspace(0, 1, 11),
        np.linspace(0, 0.75, 11),
    ],
    options=options,
)

evaluate_experiment(analysis_results, qubits, evaluation_parameters=None)

Evaluates the amplitude Rabi analysis workflow result.

Parameters:

Name	Type	Description	Default
analysis_results	WorkflowResult	The analysis workflow results.	required
qubits	QuantumElements	The qubits to run the experiments on.	required
evaluation_parameters	dict[str, Any] | None	The evaluation parameters.	None

Returns:

Type	Description
dict[str, dict[str, bool]]	The evaluation flags.

experiment_workflow(session, qpu, qubits, *, amplitudes, evaluation_parameters=None, temporary_parameters=None, options=None)

The Amplitude Rabi Workflow.

The workflow consists of the following steps:

• create_experiment
• compile_experiment
• run_experiment
• analysis_workflow
• evaluate_experiment
• update_qpu

Changed in version 26.4.0.

The evaluation_parameters argument has been added. This argument replaces the evaluation_parameter, evaluation_parameter_thresholds, and evaluation_fit_r2_thresholds arguments.

Deprecated in version 26.1.0.

The qubits argument of type QuantumElements is deprecated. Please pass qubits of type list[str] | str instead, i.e., the quantum element UIDs instead of the quantum element instances.

Parameters:

Name	Type	Description	Default
session	Session	The connected session to use for running the experiment.	required
qpu	QPU	The qpu consisting of the original qubits and quantum operations.	required
qubits	QuantumElements | list[str] | str	The qubits to run the experiments on, passed by UID. May be either a single qubit or a list of qubits.	required
amplitudes	QubitSweepPoints	The amplitudes to sweep over for each qubit. If qubits is a single qubit, amplitudes must be a list of numbers or an array. Otherwise it must be a list of lists of numbers or arrays.	required
evaluation_parameters	dict[str, Any] | None	The dictionary of parameters used for the evaluation task. The default evaluation parameters are defined in the evaluate_experiment task.	None
temporary_parameters	dict[str | tuple[str, str, str], dict | QuantumParameters] | None	The temporary parameters with which to update the quantum elements and topology edges. For quantum elements, the dictionary key is the quantum element UID. For topology edges, the dictionary key is the edge tuple (tag, source node UID, target node UID).	None
options	TuneUpWorkflowOptions | None	The options for building the workflow. In addition to options from [WorkflowOptions], the following custom options are supported: - create_experiment: The options for creating the experiment.	None

Returns:

Name	Type	Description
WorkflowBuilder	None	The builder of the experiment workflow.

Example

options = TuneUpExperimentWorkflowOptions()
options.create_experiment.count = 10
options.create_experiment.transition = "ge"
qpu = QPU(
    quantum_elements=[TunableTransmonQubit("q0"), TunableTransmonQubit("q1")],
    quantum_operations=TunableTransmonOperations(),
)
temp_qubits = qpu.copy_quantum_elements()
result = experiment_workflow(
    session=session,
    qpu=qpu,
    qubits=temp_qubits,
    amplitudes=[
        np.linspace(0, 1, 11),
        np.linspace(0, 0.75, 11),
    ],
    options=options,
).run()