Note
This is the documentation for the current state of the development branch of Qiskit Experiments. The documentation or APIs here can change prior to being released.
T2HahnBackend¶
- class T2HahnBackend(t2hahn=inf, frequency=0.0, initialization_error=0.0, readout0to1=0.0, readout1to0=0.0, seed=9000, dt=2.2222222222222221e-10, num_qubits=None)[source]¶
A simple and primitive backend, to be run by the T2Hahn tests
Initialize the T2Hahn backend
Attributes
- coupling_map¶
Return the
CouplingMap
object
- dt¶
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
- Returns:
The input signal timestep in seconds. If the backend doesn’t define
dt
,None
will be returned.
- dtm¶
Return the system time resolution of output signals
- Returns:
The output signal timestep in seconds.
- Raises:
NotImplementedError – if the backend doesn’t support querying the output signal timestep
- instruction_durations¶
Return the
InstructionDurations
object.
- instruction_schedule_map¶
Return the
InstructionScheduleMap
for the instructions defined in this backend’s target.
- instructions¶
A list of Instruction tuples on the backend of the form
(instruction, (qubits)
- max_circuits¶
- meas_map¶
Return the grouping of measurements which are multiplexed
This is required to be implemented if the backend supports Pulse scheduling.
- Returns:
The grouping of measurements which are multiplexed
- Raises:
NotImplementedError – if the backend doesn’t support querying the measurement mapping
- num_qubits¶
Return the number of qubits the backend has.
- operation_names¶
A list of instruction names that the backend supports.
- operations¶
A list of
Instruction
instances that the backend supports.
- 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.
- provider¶
Return the backend Provider.
- Returns:
the Provider responsible for the backend.
- Return type:
Provider
- target¶
- version = 2¶
- description¶
Optional human-readable description.
- online_date¶
Date that the backend came online.
- backend_version¶
Version of the backend being provided. This is not the same as
BackendV2.version
, which is the version of theBackend
abstract interface.
Methods
- acquire_channel(qubit)¶
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
- Returns:
The Qubit measurement acquisition line.
- Return type:
AcquireChannel
- Raises:
NotImplementedError – if the backend doesn’t support querying the measurement mapping
- control_channel(qubits)¶
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
- Parameters:
qubits (Iterable[int]) – Tuple or list of qubits of the form
(control_qubit, target_qubit)
.- Returns:
The multi qubit control line.
- Return type:
List[ControlChannel]
- Raises:
NotImplementedError – if the backend doesn’t support querying the measurement mapping
- drive_channel(qubit)¶
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
- Returns:
The Qubit drive channel
- Return type:
DriveChannel
- Raises:
NotImplementedError – if the backend doesn’t support querying the measurement mapping
- measure_channel(qubit)¶
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
- Returns:
The Qubit measurement stimulus line
- Return type:
MeasureChannel
- Raises:
NotImplementedError – if the backend doesn’t support querying the measurement mapping
- qubit_properties(qubit)¶
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
- Parameters:
qubit (int | List[int]) – The qubit to get the
QubitProperties
object for. This can be a single integer for 1 qubit or a list of qubits and a list ofQubitProperties
objects will be returned in the same order- Returns:
The
QubitProperties
object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can beNone
.- Raises:
NotImplementedError – if the backend doesn’t support querying the qubit properties
- Return type:
QubitProperties | List[QubitProperties]
- run(run_input, shots=1024, **options)[source]¶
Run on the backend.
This method returns a
Job
object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation.- Parameters:
run_input (QuantumCircuit or Schedule or ScheduleBlock or list) – An individual or a list of
QuantumCircuit
,ScheduleBlock
, orSchedule
objects to run on the backend.options – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
- Returns:
The job object for the run
- Return type:
Job
- 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