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.

MockIQParallelBackend¶

class MockIQParallelBackend(experiment_helper=None, rng_seed=0)[source]¶

A mock backend for testing parallel experiments with IQ data.

Initialize the backend.

Parameters:

experiment_helper (MockIQParallelExperimentHelper) – Parallel experiment helper class that contains helper classes for each experiment.
rng_seed (int) – The random seed value.

Attributes

coupling_map¶: Return the CouplingMap object

dt¶

Return the system time resolution of input signals

This is required to be implemented if the backend supports Pulse scheduling.

Returns:: The input signal timestep in seconds. If the backend doesn’t define dt, None will be returned.

dtm¶

Return the system time resolution of output signals

Returns:: The output signal timestep in seconds.
Raises:: NotImplementedError – if the backend doesn’t support querying the output signal timestep

experiment_helper¶: return the ‘experiment_helper’ attribute

instruction_durations¶: Return the InstructionDurations object.

instruction_schedule_map¶: Return the InstructionScheduleMap for the instructions defined in this backend’s target.

Deprecated since version 1.3: The property qiskit.providers.backend.BackendV2.instruction_schedule_map is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: https://github.com/qiskit-community/qiskit-dynamics. Note that once removed, qiskit.providers.backend.BackendV2.instruction_schedule_map will have no alternative in Qiskit.

instructions¶: A list of Instruction tuples on the backend of the form (instruction, (qubits)

max_circuits¶

meas_map¶

Return the grouping of measurements which are multiplexed

This is required to be implemented if the backend supports Pulse scheduling.

Returns:: The grouping of measurements which are multiplexed
Raises:: NotImplementedError – if the backend doesn’t support querying the measurement mapping

num_qubits¶: Return the number of qubits the backend has.

operation_names¶: A list of instruction names that the backend supports.

operations¶: A list of Instruction instances that the backend supports.

options¶

Return the options for the backend

The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the run() method.

provider¶

Return the backend Provider.

Returns:: the Provider responsible for the backend.
Return type:: Provider

target¶

version = 2¶

description¶: Optional human-readable description.

online_date¶: Date that the backend came online.

backend_version¶: Version of the backend being provided. This is not the same as BackendV2.version, which is the version of the Backend abstract interface.

Methods

acquire_channel(qubit)¶

Return the acquisition channel for the given qubit.

This is required to be implemented if the backend supports Pulse scheduling.

Deprecated since version 1.3: The method qiskit.providers.backend.BackendV2.acquire_channel() is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: https://github.com/qiskit-community/qiskit-dynamics. Note that once removed, qiskit.providers.backend.BackendV2.acquire_channel() will have no alternative in Qiskit.

Returns:: The Qubit measurement acquisition line.
Return type:: AcquireChannel
Raises:: NotImplementedError – if the backend doesn’t support querying the measurement mapping

control_channel(qubits)¶

Return the secondary drive channel for the given qubit

This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.

This is required to be implemented if the backend supports Pulse scheduling.

Deprecated since version 1.3: The method qiskit.providers.backend.BackendV2.control_channel() is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: https://github.com/qiskit-community/qiskit-dynamics. Note that once removed, qiskit.providers.backend.BackendV2.control_channel() will have no alternative in Qiskit.

Parameters:: qubits (Iterable[int]) – Tuple or list of qubits of the form (control_qubit, target_qubit).
Returns:: The multi qubit control line.
Return type:: List[ControlChannel]
Raises:: NotImplementedError – if the backend doesn’t support querying the measurement mapping

drive_channel(qubit)¶

Return the drive channel for the given qubit.

This is required to be implemented if the backend supports Pulse scheduling.

Deprecated since version 1.3: The method qiskit.providers.backend.BackendV2.drive_channel() is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: https://github.com/qiskit-community/qiskit-dynamics. Note that once removed, qiskit.providers.backend.BackendV2.drive_channel() will have no alternative in Qiskit.

Returns:: The Qubit drive channel
Return type:: DriveChannel
Raises:: NotImplementedError – if the backend doesn’t support querying the measurement mapping

measure_channel(qubit)¶

Return the measure stimulus channel for the given qubit.

This is required to be implemented if the backend supports Pulse scheduling.

Deprecated since version 1.3: The method qiskit.providers.backend.BackendV2.measure_channel() is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: https://github.com/qiskit-community/qiskit-dynamics. Note that once removed, qiskit.providers.backend.BackendV2.measure_channel() will have no alternative in Qiskit.

Returns:: The Qubit measurement stimulus line
Return type:: MeasureChannel
Raises:: NotImplementedError – if the backend doesn’t support querying the measurement mapping

qubit_properties(qubit)¶

Return QubitProperties for a given qubit.

If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.

Parameters:: qubit (int | List[int]) – The qubit to get the QubitProperties object for. This can be a single integer for 1 qubit or a list of qubits and a list of QubitProperties objects will be returned in the same order
Returns:: The QubitProperties object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be None.
Raises:: NotImplementedError – if the backend doesn’t support querying the qubit properties
Return type:: QubitProperties | List[QubitProperties]

run(run_input, **run_options)[source]¶

Run the IQ backend.

Parameters:

run_input (List[QuantumCircuit]) – A list of QuantumCircuit for which the backend will generate data.
**run_options –
Experiment running options. The options that are supported in this backend are meas_level, meas_return and shots:
- meas_level: To generate data in the IQ plane, meas_level should be assigned 1 or MeasLevel.KERNELED. If meas_level is 2 or MeasLevel.CLASSIFIED, the generated data will be in the form of counts.
- meas_return: This option will only take effect if meas_level = MeasLevel.CLASSIFIED. It can get either MeasReturnType.AVERAGE or MeasReturnType.SINGLE. For MeasReturnType.SINGLE, the data of each shot will be stored in the result. For MeasReturnType.AVERAGE, an average of all the shots will be calculated and stored in the result.
- shots: The number of times the circuit will run.

Returns:

A job that contains the simulated data.

Return type:

FakeJob

Raises:

QiskitError – Raised if the user try to run the experiment without setting a helper.

set_options(**fields)¶

Set the options fields for the backend

This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options.

Parameters:: fields – The fields to update the options
Raises:: AttributeError – If the field passed in is not part of the options