qiskit.providers.basicaer.StatevectorSimulatorPy
class StatevectorSimulatorPy(configuration=None, provider=None)
Python statevector simulator.
Base class for backends.
This method should initialize the module and its configuration, and raise an exception if a component of the module is not available.
Parameters
- configuration (BackendConfiguration) – backend configuration
- provider (BaseProvider) – provider responsible for this backend
Raises
QiskitError – if an error occurred when instantiating the backend.
__init__
__init__(configuration=None, provider=None)
Base class for backends.
This method should initialize the module and its configuration, and raise an exception if a component of the module is not available.
Parameters
- configuration (BackendConfiguration) – backend configuration
- provider (BaseProvider) – provider responsible for this backend
Raises
QiskitError – if an error occurred when instantiating the backend.
Methods
__init__([configuration, provider]) | Base class for backends. |
configuration() | Return the backend configuration. |
name() | Return the backend name. |
properties() | Return the backend properties. |
provider() | Return the backend Provider. |
run(qobj[, backend_options]) | Run qobj asynchronously. |
run_experiment(experiment) | Run an experiment (circuit) and return a single experiment result. |
status() | Return the backend status. |
version() | Return the backend version. |
Attributes
DEFAULT_CONFIGURATION | |
DEFAULT_OPTIONS | |
MAX_QUBITS_MEMORY | |
SHOW_FINAL_STATE |
configuration
configuration()
Return the backend configuration.
Returns
the configuration for the backend.
Return type
name
name()
Return the backend name.
Returns
the name of the backend.
Return type
str
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(qobj, backend_options=None)
Run qobj asynchronously.
Parameters
- qobj (Qobj) – 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_statevector": vector_like
* "chop_threshold": double
The "initial_statevector" option specifies a custom initial
initial statevector for the simulator to be used instead of the all
zero state. This size of this vector must be correct for the number
of qubits in all experiments in the qobj.
The "chop_threshold" option specifies a truncation value for
setting small values to zero in the output statevector. The default
value is 1e-15.
Example::
backend_options = {
"initial_statevector": np.array([1, 0, 0, 1j]) / np.sqrt(2),
"chop_threshold": 1e-15
}run_experiment
run_experiment(experiment)
Run an experiment (circuit) and return a single experiment result.
Parameters
experiment (QobjExperiment) – 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":
{
"counts": {'0x9: 5, ...},
"memory": ['0x9', '0xF', '0x1D', ..., '0x9']
},
"status": status string for the simulation
"success": boolean
"time_taken": simulation time of this single experiment
}Return type
dict
Raises
BasicAerError – if an error occurred.
status
version
version()
Return the backend version.
Returns
the X.X.X version of the backend.
Return type
str