class UnitarySimulator(configuration=None, provider=None)[source]

Ideal quantum circuit unitary simulator.

Backend options

The following backend options may be used with in the backend_options kwarg for UnitarySimulator.run() or qiskit.execute.

  • "initial_unitary" (matrix_like): Sets a custom initial unitary matrix for the simulation instead of identity (Default: None).

  • "validation_threshold" (double): Sets the threshold for checking if initial unitary and target unitary are unitary matrices. (Default: 1e-8).

  • "zero_threshold" (double): Sets the threshold for truncating small values to zero in the result data (Default: 1e-10).

  • "max_parallel_threads" (int): Sets the maximum number of CPU cores used by OpenMP for parallelization. If set to 0 the maximum will be set to the number of CPU cores (Default: 0).

  • "max_parallel_experiments" (int): Sets the maximum number of qobj experiments that may be executed in parallel up to the max_parallel_threads value. If set to 1 parallel circuit execution will be disabled. If set to 0 the maximum will be automatically set to max_parallel_threads (Default: 1).

  • "max_memory_mb" (int): Sets the maximum size of memory to store a state vector. If a state vector needs more, an error is thrown. In general, a state vector of n-qubits uses 2^n complex values (16 Bytes). If set to 0, the maximum will be automatically set to half the system memory size (Default: 0).

  • "statevector_parallel_threshold" (int): Sets the threshold that 2 * “n_qubits” must be greater than to enable OpenMP parallelization for matrix multiplication during execution of an experiment. If parallel circuit or shot execution is enabled this will only use unallocated CPU cores up to max_parallel_threads. Note that setting this too low can reduce performance (Default: 14).

Aer 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.

  • controller (function) – Aer controller to be executed

  • configuration (BackendConfiguration) – backend configuration

  • provider (BaseProvider) – provider responsible for this backend

  • FileNotFoundError if backend executable is not available.

  • AerError – if there is no name in the configuration






Return the backend configuration.


Return the backend name.


Return the backend properties.


Return the backend Provider.

UnitarySimulator.run(qobj[, …])

Run a qobj on the backend.


Return backend status.


Return the backend version.