Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK and does not exist in the latest version. We recommend you migrate to the latest version. See the release notes for more information.

QasmSimulatorPy

class QasmSimulatorPy(configuration=None, provider=None, **fields)

GitHub

Bases: qiskit.providers.backend.BackendV1

Python implementation of a qasm simulator.

Initialize a backend class

Parameters

  • configuration (BackendConfiguration) – A backend configuration object for the backend object.
  • provider (qiskit.providers.Provider) – Optionally, the provider object that this Backend comes from.
  • fields – kwargs for the values to use to override the default options.

Raises

AttributeError – if input field not a valid options

In addition to the public abstract methods, subclasses should also implement the following private methods:

_default_options

classmethod _default_options()

Return the default options

This method will return a qiskit.providers.Options subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend.

Returns

A options object with

default values set

Return type

qiskit.providers.Options


Methods

configuration

QasmSimulatorPy.configuration()

Return the backend configuration.

Returns

the configuration for the backend.

Return type

BackendConfiguration

name

QasmSimulatorPy.name()

Return the backend name.

Returns

the name of the backend.

Return type

str

properties

QasmSimulatorPy.properties()

Return the backend properties.

Returns

the configuration for the backend. If the backend does not support properties, it returns None.

Return type

BackendProperties

provider

QasmSimulatorPy.provider()

Return the backend Provider.

Returns

the Provider responsible for the backend.

Return type

Provider

run

QasmSimulatorPy.run(qobj, **backend_options)

Run qobj asynchronously.

Parameters

  • qobj (Qobj) – payload of the experiment
  • backend_options (dict) – backend options

Returns

derived from BaseJob

Return type

BasicAerJob

Additional Information:

backend_options: Is a dict of options for the backend. It may contain

  • “initial_statevector”: vector_like

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.

Example:

backend_options = {
    "initial_statevector": np.array([1, 0, 0, 1j]) / np.sqrt(2),
}

run_experiment

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

set_options

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

status

QasmSimulatorPy.status()

Return the backend status.

Returns

the status of the backend.

Return type

BackendStatus


Attributes

DEFAULT_CONFIGURATION

Default value: {'backend_name': 'qasm_simulator', 'backend_version': '2.1.0', 'basis_gates': ['u1', 'u2', 'u3', 'rz', 'sx', 'x', 'cx', 'id', 'unitary'], 'conditional': True, 'coupling_map': None, 'description': 'A python simulator for qasm experiments', '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': 65536, 'memory': True, 'n_qubits': 24, 'open_pulse': False, 'simulator': True, 'url': 'https://github.com/Qiskit/qiskit-terra'}

DEFAULT_OPTIONS

Default value: {'chop_threshold': 1e-15, 'initial_statevector': None}

MAX_QUBITS_MEMORY

Default value: 28

SHOW_FINAL_STATE

Default value: False

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

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