Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit Runtime client Go to the latest version
Important

IBM Quantum Platform is moving and this version will be sunset on July 1. To get started on the new platform, read the migration guide.

SimulatorOptions

class SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)

GitHub

Simulator options.

For best practice in simulating a backend make sure to pass the basis gates and coupling map of that backend.

Parameters

  • noise_model (Union[dict, NoiseModel, None]) – Noise model for the simulator.
  • seed_simulator (Optional[int]) – Random seed to control sampling.
  • coupling_map (Union[List[List[int]], CouplingMap, None]) – Directed coupling map to target in mapping. If the coupling map is symmetric, both directions need to be specified. Each entry in the list specifies a directed two-qubit interactions, e.g: [[0, 1], [0, 3], [1, 2], [1, 5], [2, 5], [4, 1], [5, 3]]
  • basis_gates (Optional[List[str]]) – List of basis gate names to unroll to. For example, ['u1', 'u2', 'u3', 'cx']. If None, do not unroll.

Attributes

basis_gates

Type: List[str] | None

Default value: None

coupling_map

Type: List[List[int]] | CouplingMap | None

Default value: None

noise_model

Type: dict | NoiseModel | None

Default value: None

seed_simulator

Type: int | None

Default value: None


Methods

set_backend

set_backend(backend)

GitHub

Set backend for simulation. This method changes noise_model, coupling_map, basis_gates according to given backend.

Parameters

backend (Union[BackendV1, BackendV2]) – backend to be set.

Raises

MissingOptionalLibraryError if qiskit-aer is not found.

Return type

None

validate_simulator_options

static validate_simulator_options(simulator_options)

GitHub

Validate that simulator options are legal. :raises ValueError: if any simulator option is not supported

Return type

None

Was this page helpful?
Report a bug or request content on GitHub.