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.
- 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 theBackend
abstract interface.
Methods
- 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 ofQubitProperties
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 beNone
.- 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 orMeasLevel.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 eitherMeasReturnType.AVERAGE
orMeasReturnType.SINGLE
. ForMeasReturnType.SINGLE
, the data of each shot will be stored in the result. ForMeasReturnType.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