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

FakeAuckland

FakeAuckland GitHub(opens in a new tab)

Bases: qiskit.providers.fake_provider.fake_backend.FakeBackendV2

A fake 27 qubit backend.

FakeBackendV2 initializer.


Methods

acquire_channel

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

control_channel

FakeAuckland.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]

drive_channel

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

measure_channel

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

qubit_properties

FakeAuckland.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 (Union[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 of QubitProperties 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 be None.

Return type

qubit_properties

Raises

NotImplementedError – if the backend doesn’t support querying the qubit properties

run

FakeAuckland.run(run_input, **options)

Run on the fake backend using a simulator.

This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer or Aer simulator and returns a Job object.

If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator without noise.

Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.

Parameters

  • run_input (QuantumCircuit orSchedule orScheduleBlock or list) – An individual or a list of ScheduleBlock, or Schedule 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

Raises

  • QiskitError – If a pulse job is supplied and qiskit-aer is not
  • installed.

set_options

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


Attributes

backend_name

= 'fake_auckland'

conf_filename

= 'conf_auckland.json'

coupling_map

Return the CouplingMap object

defs_filename

= 'defs_auckland.json'

dirname

= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.8/site-packages/qiskit/providers/fake_provider/backends/auckland'

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

Return type

dt

dtm

Return the system time resolution of output signals

Returns

The output signal timestep in seconds.

Return type

dtm

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)

Return type

List[Tuple[Instruction, Tuple[int]]]

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

Return type

meas_map

num_qubits

Return the number of qubits the backend has.

Return type

int

operation_names

A list of instruction names that the backend supports.

Return type

List[str]

operations

A list of Instruction instances that the backend supports.

Return type

List[Instruction]

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.

props_filename

= 'props_auckland.json'

provider

Return the backend Provider.

Returns

the Provider responsible for the backend.

Return type

Provider

target

A qiskit.transpiler.Target object for the backend.

Return type

Target

version

= 2

Was this page helpful?