Skip to main contentIBM Quantum Documentation

BackendProperties

class qiskit.providers.models.BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)

GitHub

Bases: object

Class representing backend properties

This holds backend properties measured by the provider. All properties which are provided optionally. These properties may describe qubits, gates, or other general properties of the backend.

Initialize a BackendProperties instance.

Deprecated since version 1.2

The class qiskit.providers.models.backendproperties.BackendProperties is deprecated as of qiskit 1.2. It will be removed in the 2.0 release. The models in qiskit.providers.models and related objects are part of the deprecated BackendV1 workflow, and no longer necessary for BackendV2. If a user workflow requires these representations it likely relies on deprecated functionality and should be updated to use BackendV2.

Parameters

  • backend_name (str) – Backend name.
  • backend_version (str) – Backend version in the form X.Y.Z.
  • last_update_date (datetime.datetime orstr) – Last date/time that a property was updated. If specified as a str, it must be in ISO format.
  • qubits (list) – System qubit parameters as a list of lists of Nduv objects
  • gates (list) – System gate parameters as a list of GateProperties objects
  • general (list) – General parameters as a list of Nduv objects
  • kwargs – optional additional fields

Methods

faulty_gates

faulty_gates()

GitHub

Return a list of faulty gates.

faulty_qubits

faulty_qubits()

GitHub

Return a list of faulty qubits.

frequency

frequency(qubit)

GitHub

Return the frequency of the given qubit.

Parameters

qubit (int) – Qubit for which to return frequency of.

Returns

Frequency of the given qubit.

Return type

float

from_dict

classmethod from_dict(data)

GitHub

Create a new BackendProperties object from a dictionary.

Parameters

data (dict) – A dictionary representing the BackendProperties to create. It will be in the same format as output by to_dict().

Returns

The BackendProperties from the input dictionary.

Return type

BackendProperties

gate_error

gate_error(gate, qubits)

GitHub

Return gate error estimates from backend properties.

Parameters

  • gate (str) – The gate for which to get the error.
  • qubits (int |Iterable[int]) – The specific qubits for the gate.

Returns

Gate error of the given gate and qubit(s).

Return type

float

gate_length

gate_length(gate, qubits)

GitHub

Return the duration of the gate in units of seconds.

Parameters

  • gate (str) – The gate for which to get the duration.
  • qubits (int |Iterable[int]) – The specific qubits for the gate.

Returns

Gate length of the given gate and qubit(s).

Return type

float

gate_property

gate_property(gate, qubits=None, name=None)

GitHub

Return the property of the given gate.

Parameters

  • gate (str) – Name of the gate.
  • qubits (int |Iterable[int] | None) – The qubit to find the property for.
  • name (str | None) – Optionally used to specify which gate property to return.

Returns

Gate property as a tuple of the value and the time it was measured.

Raises

BackendPropertyError – If the property is not found or name is specified but qubit is not.

Return type

Dict[Tuple[int, …], Dict[str, Tuple[Any, datetime]]] | Dict[str, Tuple[Any, datetime]] | Tuple[Any, datetime]

is_gate_operational

is_gate_operational(gate, qubits=None)

GitHub

Return the operational status of the given gate.

Parameters

  • gate (str) – Name of the gate.
  • qubits (int |Iterable[int] | None) – The qubit to find the operational status for.

Returns

Operational status of the given gate. True if the gate is operational, False otherwise.

Return type

bool

is_qubit_operational

is_qubit_operational(qubit)

GitHub

Return the operational status of the given qubit.

Parameters

qubit (int) – Qubit for which to return operational status of.

Returns

Operational status of the given qubit.

Return type

bool

qubit_property

qubit_property(qubit, name=None)

GitHub

Return the property of the given qubit.

Parameters

  • qubit (int) – The property to look for.
  • name (str | None) – Optionally used to specify within the hierarchy which property to return.

Returns

Qubit property as a tuple of the value and the time it was measured.

Raises

BackendPropertyError – If the property is not found.

Return type

Dict[str, Tuple[Any, datetime]] | Tuple[Any, datetime]

readout_error

readout_error(qubit)

GitHub

Return the readout error of the given qubit.

Parameters

qubit (int) – Qubit for which to return the readout error of.

Returns

Readout error of the given qubit.

Return type

float

readout_length

readout_length(qubit)

GitHub

Return the readout length [sec] of the given qubit.

Parameters

qubit (int) – Qubit for which to return the readout length of.

Returns

Readout length of the given qubit.

Return type

float

t1

t1(qubit)

GitHub

Return the T1 time of the given qubit.

Parameters

qubit (int) – Qubit for which to return the T1 time of.

Returns

T1 time of the given qubit.

Return type

float

t2

t2(qubit)

GitHub

Return the T2 time of the given qubit.

Parameters

qubit (int) – Qubit for which to return the T2 time of.

Returns

T2 time of the given qubit.

Return type

float

to_dict

to_dict()

GitHub

Return a dictionary format representation of the BackendProperties.

Returns

The dictionary form of the BackendProperties.

Return type

dict

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