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.

qiskit.providers.BaseBackend

class BaseBackend(configuration, provider=None)

GitHub

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

__init__

abstract __init__(configuration, provider=None)

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

__init__(configuration[, provider])Base class for backends.
configuration()Return the backend configuration.
name()Return the backend name.
properties()Return the backend properties.
provider()Return the backend Provider.
run(qobj)Run a Qobj on the the backend.
status()Return the backend status.
version()Return the backend version.

configuration

configuration()

Return the backend configuration.

Returns

the configuration for the backend.

Return type

BackendConfiguration

name

name()

Return the backend name.

Returns

the name of the backend.

Return type

str

properties

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

provider()

Return the backend Provider.

Returns

the Provider responsible for the backend.

Return type

BaseProvider

run

abstract run(qobj)

Run a Qobj on the the backend.

Parameters

qobj (Qobj) – the Qobj to be executed.

status

status()

Return the backend status.

Returns

the status of the backend.

Return type

BackendStatus

version

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.