BackendProperties
class BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)
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.
Parameters
- backend_name (str) – Backend name.
- backend_version (str) – Backend version in the form X.Y.Z.
- last_update_date (datetime or str) – 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
Nduvobjects - gates (list) – System gate parameters as a list of
Gateobjects - general (list) – General parameters as a list of
Nduvobjects - kwargs – optional additional fields
Methods
faulty_gates
BackendProperties.faulty_gates()
Return a list of faulty gates.
faulty_qubits
BackendProperties.faulty_qubits()
Return a list of faulty qubits.
frequency
BackendProperties.frequency(qubit)
Return the frequency of the given qubit.
Parameters
qubit (int) – Qubit for which to return frequency of.
Return type
float
Returns
Frequency of the given qubit.
from_dict
classmethod BackendProperties.from_dict(data)
Create a new Gate object from a dictionary.
Parameters
data (dict) – A dictionary representing the Gate to create. It will be in the same format as output by to_dict().
Returns
The BackendProperties from the input
dictionary.
Return type
gate_error
BackendProperties.gate_error(gate, qubits)
Return gate error estimates from backend properties.
Parameters
- gate (
str) – The gate for which to get the error. - qubits (
Union[int,Iterable[int]]) – The specific qubits for the gate.
Return type
float
Returns
Gate error of the given gate and qubit(s).
gate_length
BackendProperties.gate_length(gate, qubits)
Return the duration of the gate in units of seconds.
Parameters
- gate (
str) – The gate for which to get the duration. - qubits (
Union[int,Iterable[int]]) – The specific qubits for the gate.
Return type
float
Returns
Gate length of the given gate and qubit(s).
gate_property
BackendProperties.gate_property(gate, qubits=None, name=None)
Return the property of the given gate.
Parameters
- gate (
str) – Name of the gate. - qubits (
Union[int,Iterable[int],None]) – The qubit to find the property for. - name (
Optional[str]) – Optionally used to specify which gate property to return.
Return type
Tuple[Any, datetime]
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.
is_gate_operational
BackendProperties.is_gate_operational(gate, qubits=None)
Return the operational status of the given gate.
Parameters
- gate (
str) – Name of the gate. - qubits (
Union[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
BackendProperties.is_qubit_operational(qubit)
Return the operational status of the given qubit.
Parameters
qubit (int) – Qubit for which to return operational status of.
Return type
bool
Returns
Operational status of the given qubit.
qubit_property
BackendProperties.qubit_property(qubit, name=None)
Return the property of the given qubit.
Parameters
- qubit (
int) – The property to look for. - name (
Optional[str]) – Optionally used to specify within the hierarchy which property to return.
Return type
Tuple[Any, datetime]
Returns
Qubit property as a tuple of the value and the time it was measured.
Raises
BackendPropertyError – If the property is not found.
readout_error
BackendProperties.readout_error(qubit)
Return the readout error of the given qubit.
Parameters
qubit (int) – Qubit for which to return the readout error of.
Return type
float
Returns
Readout error of the given qubit.
readout_length
BackendProperties.readout_length(qubit)
Return the readout length [sec] of the given qubit.
Parameters
qubit (int) – Qubit for which to return the readout length of.
Return type
float
Returns
Readout length of the given qubit.
t1
BackendProperties.t1(qubit)
Return the T1 time of the given qubit.
Parameters
qubit (int) – Qubit for which to return the T1 time of.
Return type
float
Returns
T1 time of the given qubit.
t2
BackendProperties.t2(qubit)
Return the T2 time of the given qubit.
Parameters
qubit (int) – Qubit for which to return the T2 time of.
Return type
float
Returns
T2 time of the given qubit.
to_dict
BackendProperties.to_dict()
Return a dictionary format representation of the BackendProperties.
Returns
The dictionary form of the BackendProperties.
Return type
dict