UnitarySimulatorPy
class qiskit.providers.basicaer.UnitarySimulatorPy(configuration=None, provider=None, **fields)
Bases: BackendV1
Python implementation of a unitary simulator.
The class qiskit.providers.basicaer.unitary_simulator.UnitarySimulatorPy is deprecated as of qiskit 0.46.0. It will be removed in Qiskit 1.0.0. The qiskit.providers.basicaer module has been superseded by qiskit.providers.basic_provider. The new module has no replacement for this class. Use the qiskit.quantum_info.Operator class instead.
Attributes
DEFAULT_CONFIGURATION
Default value: {'backend_name': 'unitary_simulator', 'backend_version': '1.1.0', 'basis_gates': ['u1', 'u2', 'u3', 'rz', 'sx', 'x', 'cx', 'id', 'unitary'], 'conditional': False, 'coupling_map': None, 'description': 'A python simulator for unitary matrix corresponding to a circuit', 'gates': [{'name': 'u1', 'parameters': ['lambda'], 'qasm_def': 'gate u1(lambda) q { U(0,0,lambda) q; }'}, {'name': 'u2', 'parameters': ['phi', 'lambda'], 'qasm_def': 'gate u2(phi,lambda) q { U(pi/2,phi,lambda) q; }'}, {'name': 'u3', 'parameters': ['theta', 'phi', 'lambda'], 'qasm_def': 'gate u3(theta,phi,lambda) q { U(theta,phi,lambda) q; }'}, {'name': 'rz', 'parameters': ['phi'], 'qasm_def': 'gate rz(phi) q { U(0,0,phi) q; }'}, {'name': 'sx', 'parameters': [], 'qasm_def': 'gate sx(phi) q { U(pi/2,7*pi/2,pi/2) q; }'}, {'name': 'x', 'parameters': [], 'qasm_def': 'gate x q { U(pi,7*pi/2,pi/2) q; }'}, {'name': 'cx', 'parameters': [], 'qasm_def': 'gate cx c,t { CX c,t; }'}, {'name': 'id', 'parameters': [], 'qasm_def': 'gate id a { U(0,0,0) a; }'}, {'name': 'unitary', 'parameters': ['matrix'], 'qasm_def': 'unitary(matrix) q1, q2,...'}], 'local': True, 'max_shots': 0, 'memory': False, 'n_qubits': 14, 'open_pulse': False, 'simulator': True, 'url': 'https://github.com/Qiskit/qiskit-terra'}
DEFAULT_OPTIONS
Default value: {'chop_threshold': 1e-15, 'initial_unitary': None}
MAX_QUBITS_MEMORY
Default value: 14
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.
version
Default value: 1
Methods
configuration
configuration()
Return the backend configuration.
Returns
the configuration for the backend.
Return type
name
properties
properties()
Return the backend properties.
Returns
the configuration for the backend. If the backend does not support properties, it returns None.
Return type
provider
provider()
Return the backend Provider.
Returns
the Provider responsible for the backend.
Return type
run
run(run_input, **backend_options)
Run experiments in run_input asynchronously.
Using a QasmQobj for the first argument to UnitarySimulatorPy.run() is deprecated as of qiskit 0.46.0. It will be removed no earlier than 3 months after the release date.
Parameters
- run_input (Qobj, QuantumCircuit, list) – payload of the experiment
- backend_options (dict) – backend options
Returns
derived from BaseJob
Return type
Additional Information:
backend_options: Is a dict of options for the backend. It may contain
* "initial_unitary": matrix_like
* "chop_threshold": double
The "initial_unitary" option specifies a custom initial unitary
matrix for the simulator to be used instead of the identity
matrix. This size of this matrix must be correct for the number
of qubits in all experiments in the run_input.
The "chop_threshold" option specifies a truncation value for
setting small values to zero in the output unitary. The default
value is 1e-15.
Example::
backend_options = {
"initial_unitary": np.array([[1, 0, 0, 0],
[0, 0, 0, 1],
[0, 0, 1, 0],
[0, 1, 0, 0]])
"chop_threshold": 1e-15
}run_experiment
run_experiment(experiment)
Run an experiment (circuit) and return a single experiment result.
Parameters
experiment (QasmQobjExperiment) – experiment from qobj experiments list
Returns
A result dictionary which looks something like:
{
"name": name of this experiment (obtained from qobj.experiment header)
"seed": random seed used for simulation
"shots": number of shots used in the simulation
"data":
{
"unitary": [[[0.0, 0.0], [1.0, 0.0]],
[[1.0, 0.0], [0.0, 0.0]]]
},
"status": status string for the simulation
"success": boolean
"time taken": simulation time of this single experiment
}Return type
Raises
BasicAerError – if the number of qubits in the circuit is greater than 24. Note that the practical qubit limit is much lower than 24.
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