BasicSimulator
class qiskit.providers.basic_provider.BasicSimulator(provider=None, target=None, **fields)
Bases: BackendV2
Python implementation of a basic (non-efficient) quantum simulator.
Parameters
- provider – An optional backwards reference to the provider object that the backend is from.
- target (Target | None) – An optional target to configure the simulator.
- fields – kwargs for the values to use to override the default options.
Raises
AttributeError – If a field is specified that’s outside the backend’s options.
Attributes
MAX_QUBITS_MEMORY
Default value: 24
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
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
Default value: 2
name
Name of the backend.
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
qubit_properties
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
run
run(run_input, **run_options)
Run on the backend.
Parameters
- run_input (QuantumCircuit orlist) – the QuantumCircuit (or list of QuantumCircuit objects) to run
- run_options (kwargs) – additional runtime backend options
Returns
derived from BaseJob
Return type
Additional Information:
-
kwarg options specified in
run_optionswill temporarily override any set options of the same name for the current run. These may include:- “initial_statevector”: vector-like. The “initial_statevector” option specifies a custom initial statevector to be used instead of the all-zero state. The size of this vector must correspond to the number of qubits in the
run_inputargument. - “seed_simulator”: int. This is the internal seed for sample generation.
- “shots”: int. Number of shots used in the simulation.
- “memory”: bool. If True, the result will contain the results of every individual shot simulation.
- “initial_statevector”: vector-like. The “initial_statevector” option specifies a custom initial statevector to be used instead of the all-zero state. The size of this vector must correspond to the number of qubits in the
Example:
backend.run(
circuit_2q,
initial_statevector = np.array([1, 0, 0, 1j]) / math.sqrt(2)
)set_options
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