qiskit.providers.basicaer.QasmSimulatorPy¶

class QasmSimulatorPy(configuration=None, provider=None, **fields)[source]¶

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

__init__(configuration=None, provider=None, **fields)[source]¶

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

Methods

`__init__`([configuration, provider])	Initialize a backend class
`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.
`set_options`(**fields)	Set the options fields for the backend
`status`()	Return the backend status.

Attributes

`DEFAULT_CONFIGURATION`
`DEFAULT_OPTIONS`
`MAX_QUBITS_MEMORY`
`SHOW_FINAL_STATE`
`options`	Return the options for the backend
`version`

configuration()¶

Return the backend configuration.

Returns: the configuration for the backend.
Return type: BackendConfiguration

name()¶

Return the backend name.

Returns: the name of the backend.
Return type: str

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

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()¶

Return the backend Provider.

Returns: the Provider responsible for the backend.
Return type: Provider

run(qobj, **backend_options)[source]¶

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(experiment)[source]¶

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(**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()¶

Return the backend status.

Returns: the status of the backend.
Return type: BackendStatus