Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

BaseBackend

BaseBackend(configuration, provider=None)

GitHub(opens in a new tab)

Base class for backends.

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

Raises

QiskitError – if an error occurred when instantiating the backend.


Methods

configuration

BaseBackend.configuration()

Return the backend configuration.

Returns

the configuration for the backend.

Return type

BackendConfiguration

name

BaseBackend.name()

Return the backend name.

Returns

the name of the backend.

Return type

str

properties

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

BaseBackend.provider()

Return the backend Provider.

Returns

the Provider responsible for the backend.

Return type

BaseProvider

run

abstract BaseBackend.run(qobj)

Run a Qobj on the the backend.

Parameters

qobj (Qobj) – the Qobj to be executed.

status

BaseBackend.status()

Return the backend status.

Returns

the status of the backend.

Return type

BackendStatus

version

BaseBackend.version()

Return the backend version.

Returns

the X.X.X version of the backend.

Return type

str

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