API documentation¶
- class pytket.extensions.qiskit.IBMQBackend(backend_name, instance=None, monitor=True, service=None, token=None, sampler_options=None)[source]¶
Bases:
Backend
A backend for running circuits on remote IBMQ devices.
The provider arguments of hub, group and project can be specified here as parameters or set in the config file using
pytket.extensions.qiskit.set_ibmq_config()
. This function can also be used to set the IBMQ API token.- Parameters:
backend_name (
str
) – Name of the IBMQ device, e.g. ibmq_16_melbourne.instance (
Optional
[str
]) – String containing information about the hub/group/project.monitor (
bool
) – Use the IBM job monitor. Defaults to True.service (
Optional
[QiskitRuntimeService
]) – A QiskitRuntimeServicetoken (
Optional
[str
]) – Authentication token to use the QiskitRuntimeService.sampler_options (
Optional
[SamplerOptions
]) – A customised qiskit_ibm_runtime SamplerOptions instance. See the Qiskit documentation at https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions for details and default values.
- Raises:
ValueError – If no IBMQ account is loaded and none exists on the disk.
- __init__(backend_name, instance=None, monitor=True, service=None, token=None, sampler_options=None)[source]¶
- classmethod available_devices(**kwargs)[source]¶
Retrieve all available devices as a list of BackendInfo objects, including device name, architecture, supported gate set, gate errors, and other hardware-specific information.
- Returns:
A list of BackendInfo objects describing available devices.
- Return type:
List[BackendInfo]
- cancel(handle)[source]¶
Cancel a job.
- Parameters:
handle (ResultHandle) – handle to job
- Raises:
NotImplementedError – If backend does not support job cancellation
- Return type:
- circuit_status(handle)[source]¶
Return a CircuitStatus reporting the status of the circuit execution corresponding to the ResultHandle
- Return type:
- default_compilation_pass(optimisation_level=2)[source]¶
A suggested compilation pass that will will, if possible, produce an equivalent circuit suitable for running on this backend.
At a minimum it will ensure that compatible gates are used and that all two- qubit interactions are compatible with the backend’s qubit architecture. At higher optimisation levels, further optimisations may be applied.
This is a an abstract method which is implemented in the backend itself, and so is tailored to the backend’s requirements.
The default compilation passes for the
IBMQBackend
and the- Parameters:
optimisation_level (
int
) –The level of optimisation to perform during compilation.
Level 0 does the minimum required to solves the device constraints, without any optimisation.
Level 1 additionally performs some light optimisations.
Level 2 (the default) adds more computationally intensive optimisations that should give the best results from execution.
- Return type:
- Returns:
Compilation pass guaranteeing required predicates.
- get_result(handle, **kwargs)[source]¶
See
pytket.backends.Backend.get_result()
. Supported kwargs: timeout, wait.- Return type:
- process_circuits(circuits, n_shots=None, valid_check=True, **kwargs)[source]¶
See
pytket.backends.Backend.process_circuits()
.- Keyword Arguments:
- postprocess:
apply end-of-circuit simplifications and classical postprocessing to improve fidelity of results (bool, default False)
- simplify_initial:
apply the pytket
SimplifyInitial
pass to improve fidelity of results assuming all qubits initialized to zero (bool, default False)
- sampler_options:
A customised qiskit_ibm_runtime SamplerOptions instance. See the Qiskit documentation at https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions for details and default values.
- Return type:
- rebase_pass()[source]¶
A single compilation pass that when run converts all gates in a Circuit to an OpType supported by the Backend (ignoring architecture constraints).
- Returns:
Compilation pass that converts gates to primitives supported by Backend.
- Return type:
BasePass
- property backend_info: BackendInfo¶
Retrieve all Backend properties in a BackendInfo object, including device architecture, supported gate set, gate errors and other hardware-specific information.
- Returns:
The BackendInfo describing this backend if it exists.
- Return type:
Optional[BackendInfo]
- class pytket.extensions.qiskit.IBMQEmulatorBackend(backend_name, instance=None, service=None, token=None)[source]¶
Bases:
Backend
A backend which uses the AerBackend to loaclly emulate the behaviour of IBMQBackend. Identical to
IBMQBackend
except there is no monitor parameter. Performs the same compilation and predicate checks as IBMQBackend. Requires a valid IBM account.- cancel(handle)[source]¶
Cancel a job.
- Parameters:
handle (ResultHandle) – handle to job
- Raises:
NotImplementedError – If backend does not support job cancellation
- Return type:
- circuit_status(handle)[source]¶
Return a CircuitStatus reporting the status of the circuit execution corresponding to the ResultHandle
- Return type:
- default_compilation_pass(optimisation_level=2)[source]¶
See documentation for
IBMQBackend.default_compilation_pass()
.- Return type:
- get_result(handle, **kwargs)[source]¶
See
pytket.backends.Backend.get_result()
. Supported kwargs: none.- Return type:
- process_circuits(circuits, n_shots=None, valid_check=True, **kwargs)[source]¶
See
pytket.backends.Backend.process_circuits()
. Supported kwargs: seed, postprocess.- Return type:
- rebase_pass()[source]¶
A single compilation pass that when run converts all gates in a Circuit to an OpType supported by the Backend (ignoring architecture constraints).
- Returns:
Compilation pass that converts gates to primitives supported by Backend.
- Return type:
BasePass
- property backend_info: BackendInfo¶
Retrieve all Backend properties in a BackendInfo object, including device architecture, supported gate set, gate errors and other hardware-specific information.
- Returns:
The BackendInfo describing this backend if it exists.
- Return type:
Optional[BackendInfo]
- class pytket.extensions.qiskit.AerBackend(noise_model=None, simulation_method='automatic', crosstalk_params=None, n_qubits=40)[source]¶
Backend for running simulations on the Qiskit Aer QASM simulator.
- Parameters:
noise_model (
Optional
[NoiseModel
]) – Noise model to apply during simulation. Defaults to None.simulation_method (
str
) – Simulation method, see https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html for available values. Defaults to “automatic”.crosstalk_params (
Optional
[CrosstalkParams
]) – Apply crosstalk noise simulation to the circuits before execution. noise_model will be overwritten if this is given. Default to None.n_qubits (
int
) – The maximum number of qubits supported by the backend.
- __init__(noise_model=None, simulation_method='automatic', crosstalk_params=None, n_qubits=40)[source]¶
- classmethod available_devices(**kwargs)¶
Retrieve all available devices as a list of BackendInfo objects, including device name, architecture, supported gate set, gate errors, and other hardware-specific information.
- Returns:
A list of BackendInfo objects describing available devices.
- Return type:
List[BackendInfo]
- cancel(handle)¶
Cancel a job.
- Parameters:
handle (ResultHandle) – handle to job
- Raises:
NotImplementedError – If backend does not support job cancellation
- Return type:
- circuit_status(handle)¶
Return a CircuitStatus reporting the status of the circuit execution corresponding to the ResultHandle
- Return type:
- default_compilation_pass(optimisation_level=2)¶
See documentation for
IBMQBackend.default_compilation_pass()
.- Return type:
- get_compiled_circuit(circuit, optimisation_level=2)¶
Return a single circuit compiled with
default_compilation_pass()
. SeeBackend.get_compiled_circuits()
.- Return type:
- get_compiled_circuits(circuits, optimisation_level=2)¶
Compile a sequence of circuits with
default_compilation_pass()
and return the list of compiled circuits (does not act in place).As well as applying a degree of optimisation (controlled by the optimisation_level parameter), this method tries to ensure that the circuits can be run on the backend (i.e. successfully passed to
process_circuits()
), for example by rebasing to the supported gate set, or routing to match the connectivity of the device. However, this is not always possible, for example if the circuit contains classical operations that are not supported by the backend. You may usevalid_circuit()
to check whether the circuit meets the backend’s requirements after compilation. This validity check is included inprocess_circuits()
by default, before any circuits are submitted to the backend.If the validity check fails, you can obtain more information about the failure by iterating through the predicates in the required_predicates property of the backend, and running the
verify()
method on each in turn with your circuit.- Parameters:
optimisation_level (int, optional) – The level of optimisation to perform during compilation. See
default_compilation_pass()
for a description of the different levels (0, 1 or 2). Defaults to 2.
- Returns:
Compiled circuits.
- Return type:
List[Circuit]
- get_operator_expectation_value(state_circuit, operator, valid_check=True)¶
Calculates the expectation value of the given circuit with respect to the operator using the built-in Aer snapshot functionality Requires a simple circuit with default register qubits.
- Parameters:
state_circuit (
Circuit
) – Circuit that generates the desired state .operator (
QubitPauliOperator
) – Operator .valid_check (
bool
) – Explicitly check that the circuit satisfies all required predicates to run on the backend. Defaults to True
- Return type:
- Returns:
- get_pauli_expectation_value(state_circuit, pauli, valid_check=True)¶
Calculates the expectation value of the given circuit using the built-in Aer snapshot functionality Requires a simple circuit with default register qubits.
- Parameters:
state_circuit (
Circuit
) – Circuit that generates the desired state .pauli (
QubitPauliString
) – Pauli operatorvalid_check (
bool
) – Explicitly check that the circuit satisfies all required predicates to run on the backend. Defaults to True
- Return type:
- Returns:
- get_result(handle, **kwargs)¶
Return a BackendResult corresponding to the handle.
Use keyword arguments to specify parameters to be used in retrieving results. See specific Backend derived class for available parameters, from the following list:
timeout: maximum time to wait for remote job to finish
wait: polling interval between remote calls to check job status
- Parameters:
handle (ResultHandle) – handle to results
- Returns:
Results corresponding to handle.
- Return type:
BackendResult
- get_results(handles, **kwargs)¶
Return results corresponding to handles.
- Parameters:
handles (
Iterable
[ResultHandle
]) – Iterable of handles- Return type:
- Returns:
List of results
Keyword arguments are as for get_result, and apply to all jobs.
- pop_result(handle)¶
Remove cache entry corresponding to handle from the cache and return.
- Parameters:
handle (ResultHandle) – ResultHandle object
- Returns:
Cache entry corresponding to handle, if it was present
- Return type:
Optional[ResultCache]
- process_circuit(circuit, n_shots=None, valid_check=True, **kwargs)¶
Submit a single circuit to the backend for running. See
Backend.process_circuits()
.- Return type:
- process_circuits(circuits, n_shots=None, valid_check=True, **kwargs)¶
See
pytket.backends.Backend.process_circuits()
. Supported kwargs: seed, postprocess.- Return type:
- rebase_pass()¶
A single compilation pass that when run converts all gates in a Circuit to an OpType supported by the Backend (ignoring architecture constraints).
- Returns:
Compilation pass that converts gates to primitives supported by Backend.
- Return type:
BasePass
- run_circuit(circuit, n_shots=None, valid_check=True, **kwargs)¶
Submits a circuit to the backend and returns results
- Parameters:
- Return type:
- Returns:
Result
This is a convenience method equivalent to calling
Backend.process_circuit()
followed byBackend.get_result()
. Any additional keyword arguments are passed on toBackend.process_circuit()
andBackend.get_result()
.
- run_circuits(circuits, n_shots=None, valid_check=True, **kwargs)¶
Submits circuits to the backend and returns results
- Parameters:
- Return type:
- Returns:
List of results
This is a convenience method equivalent to calling
Backend.process_circuits()
followed byBackend.get_results()
. Any additional keyword arguments are passed on toBackend.process_circuits()
andBackend.get_results()
.
- valid_circuit(circuit)¶
Checks that the circuit satisfies all of required_predicates.
- Parameters:
circuit (Circuit) – The circuit to check.
- Returns:
Whether or not all of required_predicates are satisfied.
- Return type:
- property backend_info: BackendInfo¶
Retrieve all Backend properties in a BackendInfo object, including device architecture, supported gate set, gate errors and other hardware-specific information.
- Returns:
The BackendInfo describing this backend if it exists.
- Return type:
Optional[BackendInfo]
- property expectation_allows_nonhermitian: bool¶
If expectations are supported, is the operator allowed to be non-Hermitan?
- property persistent_handles: bool¶
Whether the backend produces ResultHandle objects that can be reused with other instances of the backend class.
- property required_predicates: list[Predicate]¶
The minimum set of predicates that a circuit must satisfy before it can be successfully run on this backend.
- Returns:
Required predicates.
- Return type:
List[Predicate]
- property supports_contextual_optimisation: bool¶
Does this backend support contextual optimisation?
See
process_circuits()
.
- property supports_counts: bool¶
Does this backend support counts result retrieval via
backendresult.BackendResult.get_counts()
.
- property supports_density_matrix: bool¶
Does this backend support density matrix retrieval via get_density_matrix.
- property supports_expectation: bool¶
Does this backend support expectation value calculation for operators.
- property supports_shots: bool¶
Does this backend support shot result retrieval via
backendresult.BackendResult.get_shots()
.
- class pytket.extensions.qiskit.AerStateBackend(n_qubits=40)[source]¶
Backend for running simulations on the Qiskit Aer Statevector simulator.
- Parameters:
n_qubits (
int
) – The maximum number of qubits supported by the backend.
- classmethod available_devices(**kwargs)¶
Retrieve all available devices as a list of BackendInfo objects, including device name, architecture, supported gate set, gate errors, and other hardware-specific information.
- Returns:
A list of BackendInfo objects describing available devices.
- Return type:
List[BackendInfo]
- cancel(handle)¶
Cancel a job.
- Parameters:
handle (ResultHandle) – handle to job
- Raises:
NotImplementedError – If backend does not support job cancellation
- Return type:
- circuit_status(handle)¶
Return a CircuitStatus reporting the status of the circuit execution corresponding to the ResultHandle
- Return type:
- default_compilation_pass(optimisation_level=2)¶
See documentation for
IBMQBackend.default_compilation_pass()
.- Return type:
- get_compiled_circuit(circuit, optimisation_level=2)¶
Return a single circuit compiled with
default_compilation_pass()
. SeeBackend.get_compiled_circuits()
.- Return type:
- get_compiled_circuits(circuits, optimisation_level=2)¶
Compile a sequence of circuits with
default_compilation_pass()
and return the list of compiled circuits (does not act in place).As well as applying a degree of optimisation (controlled by the optimisation_level parameter), this method tries to ensure that the circuits can be run on the backend (i.e. successfully passed to
process_circuits()
), for example by rebasing to the supported gate set, or routing to match the connectivity of the device. However, this is not always possible, for example if the circuit contains classical operations that are not supported by the backend. You may usevalid_circuit()
to check whether the circuit meets the backend’s requirements after compilation. This validity check is included inprocess_circuits()
by default, before any circuits are submitted to the backend.If the validity check fails, you can obtain more information about the failure by iterating through the predicates in the required_predicates property of the backend, and running the
verify()
method on each in turn with your circuit.- Parameters:
optimisation_level (int, optional) – The level of optimisation to perform during compilation. See
default_compilation_pass()
for a description of the different levels (0, 1 or 2). Defaults to 2.
- Returns:
Compiled circuits.
- Return type:
List[Circuit]
- get_operator_expectation_value(state_circuit, operator, valid_check=True)¶
Calculates the expectation value of the given circuit with respect to the operator using the built-in Aer snapshot functionality Requires a simple circuit with default register qubits.
- Parameters:
state_circuit (
Circuit
) – Circuit that generates the desired state .operator (
QubitPauliOperator
) – Operator .valid_check (
bool
) – Explicitly check that the circuit satisfies all required predicates to run on the backend. Defaults to True
- Return type:
- Returns:
- get_pauli_expectation_value(state_circuit, pauli, valid_check=True)¶
Calculates the expectation value of the given circuit using the built-in Aer snapshot functionality Requires a simple circuit with default register qubits.
- Parameters:
state_circuit (
Circuit
) – Circuit that generates the desired state .pauli (
QubitPauliString
) – Pauli operatorvalid_check (
bool
) – Explicitly check that the circuit satisfies all required predicates to run on the backend. Defaults to True
- Return type:
- Returns:
- get_result(handle, **kwargs)¶
Return a BackendResult corresponding to the handle.
Use keyword arguments to specify parameters to be used in retrieving results. See specific Backend derived class for available parameters, from the following list:
timeout: maximum time to wait for remote job to finish
wait: polling interval between remote calls to check job status
- Parameters:
handle (ResultHandle) – handle to results
- Returns:
Results corresponding to handle.
- Return type:
BackendResult
- get_results(handles, **kwargs)¶
Return results corresponding to handles.
- Parameters:
handles (
Iterable
[ResultHandle
]) – Iterable of handles- Return type:
- Returns:
List of results
Keyword arguments are as for get_result, and apply to all jobs.
- pop_result(handle)¶
Remove cache entry corresponding to handle from the cache and return.
- Parameters:
handle (ResultHandle) – ResultHandle object
- Returns:
Cache entry corresponding to handle, if it was present
- Return type:
Optional[ResultCache]
- process_circuit(circuit, n_shots=None, valid_check=True, **kwargs)¶
Submit a single circuit to the backend for running. See
Backend.process_circuits()
.- Return type:
- process_circuits(circuits, n_shots=None, valid_check=True, **kwargs)¶
See
pytket.backends.Backend.process_circuits()
. Supported kwargs: seed, postprocess.- Return type:
- rebase_pass()¶
A single compilation pass that when run converts all gates in a Circuit to an OpType supported by the Backend (ignoring architecture constraints).
- Returns:
Compilation pass that converts gates to primitives supported by Backend.
- Return type:
BasePass
- run_circuit(circuit, n_shots=None, valid_check=True, **kwargs)¶
Submits a circuit to the backend and returns results
- Parameters:
- Return type:
- Returns:
Result
This is a convenience method equivalent to calling
Backend.process_circuit()
followed byBackend.get_result()
. Any additional keyword arguments are passed on toBackend.process_circuit()
andBackend.get_result()
.
- run_circuits(circuits, n_shots=None, valid_check=True, **kwargs)¶
Submits circuits to the backend and returns results
- Parameters:
- Return type:
- Returns:
List of results
This is a convenience method equivalent to calling
Backend.process_circuits()
followed byBackend.get_results()
. Any additional keyword arguments are passed on toBackend.process_circuits()
andBackend.get_results()
.
- valid_circuit(circuit)¶
Checks that the circuit satisfies all of required_predicates.
- Parameters:
circuit (Circuit) – The circuit to check.
- Returns:
Whether or not all of required_predicates are satisfied.
- Return type:
- property backend_info: BackendInfo¶
Retrieve all Backend properties in a BackendInfo object, including device architecture, supported gate set, gate errors and other hardware-specific information.
- Returns:
The BackendInfo describing this backend if it exists.
- Return type:
Optional[BackendInfo]
- property expectation_allows_nonhermitian: bool¶
If expectations are supported, is the operator allowed to be non-Hermitan?
- property persistent_handles: bool¶
Whether the backend produces ResultHandle objects that can be reused with other instances of the backend class.
- property required_predicates: list[Predicate]¶
The minimum set of predicates that a circuit must satisfy before it can be successfully run on this backend.
- Returns:
Required predicates.
- Return type:
List[Predicate]
- property supports_contextual_optimisation: bool¶
Does this backend support contextual optimisation?
See
process_circuits()
.
- property supports_counts: bool¶
Does this backend support counts result retrieval via
backendresult.BackendResult.get_counts()
.
- property supports_density_matrix: bool¶
Does this backend support density matrix retrieval via get_density_matrix.
- property supports_expectation: bool¶
Does this backend support expectation value calculation for operators.
- property supports_shots: bool¶
Does this backend support shot result retrieval via
backendresult.BackendResult.get_shots()
.
- class pytket.extensions.qiskit.AerUnitaryBackend(n_qubits=40)[source]¶
Backend for running simulations on the Qiskit Aer Unitary simulator.
- Parameters:
n_qubits (
int
) – The maximum number of qubits supported by the backend.
- classmethod available_devices(**kwargs)¶
Retrieve all available devices as a list of BackendInfo objects, including device name, architecture, supported gate set, gate errors, and other hardware-specific information.
- Returns:
A list of BackendInfo objects describing available devices.
- Return type:
List[BackendInfo]
- cancel(handle)¶
Cancel a job.
- Parameters:
handle (ResultHandle) – handle to job
- Raises:
NotImplementedError – If backend does not support job cancellation
- Return type:
- circuit_status(handle)¶
Return a CircuitStatus reporting the status of the circuit execution corresponding to the ResultHandle
- Return type:
- default_compilation_pass(optimisation_level=2)¶
See documentation for
IBMQBackend.default_compilation_pass()
.- Return type:
- get_compiled_circuit(circuit, optimisation_level=2)¶
Return a single circuit compiled with
default_compilation_pass()
. SeeBackend.get_compiled_circuits()
.- Return type:
- get_compiled_circuits(circuits, optimisation_level=2)¶
Compile a sequence of circuits with
default_compilation_pass()
and return the list of compiled circuits (does not act in place).As well as applying a degree of optimisation (controlled by the optimisation_level parameter), this method tries to ensure that the circuits can be run on the backend (i.e. successfully passed to
process_circuits()
), for example by rebasing to the supported gate set, or routing to match the connectivity of the device. However, this is not always possible, for example if the circuit contains classical operations that are not supported by the backend. You may usevalid_circuit()
to check whether the circuit meets the backend’s requirements after compilation. This validity check is included inprocess_circuits()
by default, before any circuits are submitted to the backend.If the validity check fails, you can obtain more information about the failure by iterating through the predicates in the required_predicates property of the backend, and running the
verify()
method on each in turn with your circuit.- Parameters:
optimisation_level (int, optional) – The level of optimisation to perform during compilation. See
default_compilation_pass()
for a description of the different levels (0, 1 or 2). Defaults to 2.
- Returns:
Compiled circuits.
- Return type:
List[Circuit]
- get_operator_expectation_value(state_circuit, operator, valid_check=True)¶
Calculates the expectation value of the given circuit with respect to the operator using the built-in Aer snapshot functionality Requires a simple circuit with default register qubits.
- Parameters:
state_circuit (
Circuit
) – Circuit that generates the desired state .operator (
QubitPauliOperator
) – Operator .valid_check (
bool
) – Explicitly check that the circuit satisfies all required predicates to run on the backend. Defaults to True
- Return type:
- Returns:
- get_pauli_expectation_value(state_circuit, pauli, valid_check=True)¶
Calculates the expectation value of the given circuit using the built-in Aer snapshot functionality Requires a simple circuit with default register qubits.
- Parameters:
state_circuit (
Circuit
) – Circuit that generates the desired state .pauli (
QubitPauliString
) – Pauli operatorvalid_check (
bool
) – Explicitly check that the circuit satisfies all required predicates to run on the backend. Defaults to True
- Return type:
- Returns:
- get_result(handle, **kwargs)¶
Return a BackendResult corresponding to the handle.
Use keyword arguments to specify parameters to be used in retrieving results. See specific Backend derived class for available parameters, from the following list:
timeout: maximum time to wait for remote job to finish
wait: polling interval between remote calls to check job status
- Parameters:
handle (ResultHandle) – handle to results
- Returns:
Results corresponding to handle.
- Return type:
BackendResult
- get_results(handles, **kwargs)¶
Return results corresponding to handles.
- Parameters:
handles (
Iterable
[ResultHandle
]) – Iterable of handles- Return type:
- Returns:
List of results
Keyword arguments are as for get_result, and apply to all jobs.
- pop_result(handle)¶
Remove cache entry corresponding to handle from the cache and return.
- Parameters:
handle (ResultHandle) – ResultHandle object
- Returns:
Cache entry corresponding to handle, if it was present
- Return type:
Optional[ResultCache]
- process_circuit(circuit, n_shots=None, valid_check=True, **kwargs)¶
Submit a single circuit to the backend for running. See
Backend.process_circuits()
.- Return type:
- process_circuits(circuits, n_shots=None, valid_check=True, **kwargs)¶
See
pytket.backends.Backend.process_circuits()
. Supported kwargs: seed, postprocess.- Return type:
- rebase_pass()¶
A single compilation pass that when run converts all gates in a Circuit to an OpType supported by the Backend (ignoring architecture constraints).
- Returns:
Compilation pass that converts gates to primitives supported by Backend.
- Return type:
BasePass
- run_circuit(circuit, n_shots=None, valid_check=True, **kwargs)¶
Submits a circuit to the backend and returns results
- Parameters:
- Return type:
- Returns:
Result
This is a convenience method equivalent to calling
Backend.process_circuit()
followed byBackend.get_result()
. Any additional keyword arguments are passed on toBackend.process_circuit()
andBackend.get_result()
.
- run_circuits(circuits, n_shots=None, valid_check=True, **kwargs)¶
Submits circuits to the backend and returns results
- Parameters:
- Return type:
- Returns:
List of results
This is a convenience method equivalent to calling
Backend.process_circuits()
followed byBackend.get_results()
. Any additional keyword arguments are passed on toBackend.process_circuits()
andBackend.get_results()
.
- valid_circuit(circuit)¶
Checks that the circuit satisfies all of required_predicates.
- Parameters:
circuit (Circuit) – The circuit to check.
- Returns:
Whether or not all of required_predicates are satisfied.
- Return type:
- property backend_info: BackendInfo¶
Retrieve all Backend properties in a BackendInfo object, including device architecture, supported gate set, gate errors and other hardware-specific information.
- Returns:
The BackendInfo describing this backend if it exists.
- Return type:
Optional[BackendInfo]
- property expectation_allows_nonhermitian: bool¶
If expectations are supported, is the operator allowed to be non-Hermitan?
- property persistent_handles: bool¶
Whether the backend produces ResultHandle objects that can be reused with other instances of the backend class.
- property required_predicates: list[Predicate]¶
The minimum set of predicates that a circuit must satisfy before it can be successfully run on this backend.
- Returns:
Required predicates.
- Return type:
List[Predicate]
- property supports_contextual_optimisation: bool¶
Does this backend support contextual optimisation?
See
process_circuits()
.
- property supports_counts: bool¶
Does this backend support counts result retrieval via
backendresult.BackendResult.get_counts()
.
- property supports_density_matrix: bool¶
Does this backend support density matrix retrieval via get_density_matrix.
- property supports_expectation: bool¶
Does this backend support expectation value calculation for operators.
- property supports_shots: bool¶
Does this backend support shot result retrieval via
backendresult.BackendResult.get_shots()
.
- class pytket.extensions.qiskit.AerDensityMatrixBackend(noise_model=None, n_qubits=40)[source]¶
Backend for running simulations on the Qiskit Aer density matrix simulator.
- Parameters:
- classmethod available_devices(**kwargs)¶
Retrieve all available devices as a list of BackendInfo objects, including device name, architecture, supported gate set, gate errors, and other hardware-specific information.
- Returns:
A list of BackendInfo objects describing available devices.
- Return type:
List[BackendInfo]
- cancel(handle)¶
Cancel a job.
- Parameters:
handle (ResultHandle) – handle to job
- Raises:
NotImplementedError – If backend does not support job cancellation
- Return type:
- circuit_status(handle)¶
Return a CircuitStatus reporting the status of the circuit execution corresponding to the ResultHandle
- Return type:
- default_compilation_pass(optimisation_level=2)¶
See documentation for
IBMQBackend.default_compilation_pass()
.- Return type:
- get_compiled_circuit(circuit, optimisation_level=2)¶
Return a single circuit compiled with
default_compilation_pass()
. SeeBackend.get_compiled_circuits()
.- Return type:
- get_compiled_circuits(circuits, optimisation_level=2)¶
Compile a sequence of circuits with
default_compilation_pass()
and return the list of compiled circuits (does not act in place).As well as applying a degree of optimisation (controlled by the optimisation_level parameter), this method tries to ensure that the circuits can be run on the backend (i.e. successfully passed to
process_circuits()
), for example by rebasing to the supported gate set, or routing to match the connectivity of the device. However, this is not always possible, for example if the circuit contains classical operations that are not supported by the backend. You may usevalid_circuit()
to check whether the circuit meets the backend’s requirements after compilation. This validity check is included inprocess_circuits()
by default, before any circuits are submitted to the backend.If the validity check fails, you can obtain more information about the failure by iterating through the predicates in the required_predicates property of the backend, and running the
verify()
method on each in turn with your circuit.- Parameters:
optimisation_level (int, optional) – The level of optimisation to perform during compilation. See
default_compilation_pass()
for a description of the different levels (0, 1 or 2). Defaults to 2.
- Returns:
Compiled circuits.
- Return type:
List[Circuit]
- get_operator_expectation_value(state_circuit, operator, valid_check=True)¶
Calculates the expectation value of the given circuit with respect to the operator using the built-in Aer snapshot functionality Requires a simple circuit with default register qubits.
- Parameters:
state_circuit (
Circuit
) – Circuit that generates the desired state .operator (
QubitPauliOperator
) – Operator .valid_check (
bool
) – Explicitly check that the circuit satisfies all required predicates to run on the backend. Defaults to True
- Return type:
- Returns:
- get_pauli_expectation_value(state_circuit, pauli, valid_check=True)¶
Calculates the expectation value of the given circuit using the built-in Aer snapshot functionality Requires a simple circuit with default register qubits.
- Parameters:
state_circuit (
Circuit
) – Circuit that generates the desired state .pauli (
QubitPauliString
) – Pauli operatorvalid_check (
bool
) – Explicitly check that the circuit satisfies all required predicates to run on the backend. Defaults to True
- Return type:
- Returns:
- get_result(handle, **kwargs)¶
Return a BackendResult corresponding to the handle.
Use keyword arguments to specify parameters to be used in retrieving results. See specific Backend derived class for available parameters, from the following list:
timeout: maximum time to wait for remote job to finish
wait: polling interval between remote calls to check job status
- Parameters:
handle (ResultHandle) – handle to results
- Returns:
Results corresponding to handle.
- Return type:
BackendResult
- get_results(handles, **kwargs)¶
Return results corresponding to handles.
- Parameters:
handles (
Iterable
[ResultHandle
]) – Iterable of handles- Return type:
- Returns:
List of results
Keyword arguments are as for get_result, and apply to all jobs.
- pop_result(handle)¶
Remove cache entry corresponding to handle from the cache and return.
- Parameters:
handle (ResultHandle) – ResultHandle object
- Returns:
Cache entry corresponding to handle, if it was present
- Return type:
Optional[ResultCache]
- process_circuit(circuit, n_shots=None, valid_check=True, **kwargs)¶
Submit a single circuit to the backend for running. See
Backend.process_circuits()
.- Return type:
- process_circuits(circuits, n_shots=None, valid_check=True, **kwargs)¶
See
pytket.backends.Backend.process_circuits()
. Supported kwargs: seed, postprocess.- Return type:
- rebase_pass()¶
A single compilation pass that when run converts all gates in a Circuit to an OpType supported by the Backend (ignoring architecture constraints).
- Returns:
Compilation pass that converts gates to primitives supported by Backend.
- Return type:
BasePass
- run_circuit(circuit, n_shots=None, valid_check=True, **kwargs)¶
Submits a circuit to the backend and returns results
- Parameters:
- Return type:
- Returns:
Result
This is a convenience method equivalent to calling
Backend.process_circuit()
followed byBackend.get_result()
. Any additional keyword arguments are passed on toBackend.process_circuit()
andBackend.get_result()
.
- run_circuits(circuits, n_shots=None, valid_check=True, **kwargs)¶
Submits circuits to the backend and returns results
- Parameters:
- Return type:
- Returns:
List of results
This is a convenience method equivalent to calling
Backend.process_circuits()
followed byBackend.get_results()
. Any additional keyword arguments are passed on toBackend.process_circuits()
andBackend.get_results()
.
- valid_circuit(circuit)¶
Checks that the circuit satisfies all of required_predicates.
- Parameters:
circuit (Circuit) – The circuit to check.
- Returns:
Whether or not all of required_predicates are satisfied.
- Return type:
- property backend_info: BackendInfo¶
Retrieve all Backend properties in a BackendInfo object, including device architecture, supported gate set, gate errors and other hardware-specific information.
- Returns:
The BackendInfo describing this backend if it exists.
- Return type:
Optional[BackendInfo]
- property expectation_allows_nonhermitian: bool¶
If expectations are supported, is the operator allowed to be non-Hermitan?
- property persistent_handles: bool¶
Whether the backend produces ResultHandle objects that can be reused with other instances of the backend class.
- property required_predicates: list[Predicate]¶
The minimum set of predicates that a circuit must satisfy before it can be successfully run on this backend.
- Returns:
Required predicates.
- Return type:
List[Predicate]
- property supports_contextual_optimisation: bool¶
Does this backend support contextual optimisation?
See
process_circuits()
.
- property supports_counts: bool¶
Does this backend support counts result retrieval via
backendresult.BackendResult.get_counts()
.
- property supports_density_matrix: bool¶
Does this backend support density matrix retrieval via get_density_matrix.
- property supports_expectation: bool¶
Does this backend support expectation value calculation for operators.
- property supports_shots: bool¶
Does this backend support shot result retrieval via
backendresult.BackendResult.get_shots()
.
Module for conversion between IBM Qiskit and tket primitives.
- pytket.extensions.qiskit.process_characterisation(backend)[source]¶
Convert a
qiskit_ibm_runtime.ibm_backend.IBMBackend
to a dictionary containing device Characteristics
- pytket.extensions.qiskit.qiskit_to_tk(qcirc, preserve_param_uuid=False)[source]¶
Converts a qiskit
qiskit.QuantumCircuit
to a pytketCircuit
.- Parameters:
qcirc (
QuantumCircuit
) – A circuit to be convertedpreserve_param_uuid (
bool
) – Whether to preserve symbolic Parameter uuids by appending them to the tket Circuit symbol names as “_UUID:<uuid>”. This can be useful if you want to reassign Parameters after conversion to tket and back, as it is necessary for Parameter object equality to be preserved.
- Return type:
- Returns:
The converted circuit
- pytket.extensions.qiskit.tk_to_qiskit(tkcirc, replace_implicit_swaps=False)[source]¶
Converts a pytket
Circuit
to a qiskitqiskit.QuantumCircuit
.In many cases there will be a qiskit gate to exactly replace each tket gate. If no exact replacement can be found for a part of the circuit then an equivalent circuit will be returned using the tket gates which are supported in qiskit.
- Parameters:
- Return type:
- Returns:
The converted circuit
- class pytket.extensions.qiskit.tket_backend.TketBackend(backend, comp_pass=None)[source]¶
Bases:
BackendV2
Wraps a
Backend
as aqiskit.providers.BaseBackend
for use within the Qiskit software stack.Each
qiskit.circuit.quantumcircuit.QuantumCircuit
passed in will be converted to aCircuit
object. If aBasePass
is provided forcomp_pass
, this is applied to theCircuit
. Then it is processed by theBackend
, wrapping theResultHandle
s in aTketJob
, retrieving the results when called on the job object. The required predicates of theBackend
are presented to the Qiskit transpiler to enable it to perform the compilation in many cases. This may not always be possible due to unsupported gatesets or additional constraints that cannot be captured in Qiskit’s transpiler, in which case a customqiskit.transpiler.TranspilationPass
should be used to map into a tket- compatible gateset and setcomp_pass
to compile for the backend. To compile with tket only, setcomp_pass
and just use Qiskit to map into a tket-compatible gateset. In Qiskit Aqua, you should wrap theTketBackend
in aqiskit.aqua.QuantumInstance
, providing a customqiskit.transpiler.PassManager
with aqiskit.transpiler.passes.Unroller
. For examples, see the user manual or the Qiskit integration example.- __init__(backend, comp_pass=None)[source]¶
Create a new
TketBackend
from aBackend
.
- run(run_input, **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
) – 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
- property max_circuits: int¶
The maximum number of circuits (or Pulse schedules) that can be run in a single job.
If there is no limit this will return None
- property target: Target¶
A
qiskit.transpiler.Target
object for the backend.- Return type:
Target
- class pytket.extensions.qiskit.backends.crosstalk_model.CrosstalkParams(zz_crosstalks, single_q_phase_errors, two_q_induced_phase_errors, non_markovian_noise, virtual_z, N, gate_times, phase_damping_error, amplitude_damping_error)[source]¶
Stores various parameters for modelling crosstalk noise
- Parameters:
zz_crosstalks (
dict
[tuple
[Qubit
,Qubit
],float
]) – symmetric crosstalks between qubit pairssingle_q_phase_errors (
dict
[Qubit
,float
]) – dict specify the single qubit phase error on each qubittwo_q_induced_phase_errors (
dict
[tuple
[Qubit
,Qubit
],tuple
[Qubit
,float
]]) – keys of dictionary specify the control and target qubit index, while the values are tuples with the spectator qubit index and the amount of phase error to be applied.non_markovian_noise (
list
[tuple
[Qubit
,float
,float
]]) – List storing the non-Markovian noise parameters. Each tuple in the list contains the qubit index and the zx, zz noise parameters.virtual_z (
bool
) – If True, then don’t break any single qubit Z gate into unitary fractions, instead add the full unitary.N (
float
) – hyperparameter specifies splices per second. 1/N must divide all gate times.gate_times (
dict
[tuple
[OpType
,tuple
[Qubit
,...
]],float
]) – python dict to store the gate time information.phase_damping_error (
dict
[Qubit
,float
]) – dict specify amplitude phase damping error on each qubitamplitude_damping_error (
dict
[Qubit
,float
]) – dict pecify amplitude damping error on each qubit
- class pytket.extensions.qiskit.tket_pass.TketAutoPass(backend, optimisation_level=2, token=None)[source]¶
The tket compiler to be plugged in to the Qiskit compilation sequence
- __init__(backend, optimisation_level=2, token=None)[source]¶
Identifies a Qiskit backend and provides the corresponding default compilation pass from pytket as a
qiskit.transpiler.TransformationPass
.- Parameters:
backend (
BackendV2
) – The Qiskit backend to target. Accepts Aer or IBMQ backends.optimisation_level (
int
) – The level of optimisation to perform during compilation. Level 0 just solves the device constraints without optimising. Level 1 additionally performs some light optimisations. Level 2 adds more computationally intensive optimisations. Defaults to 2.token (
Optional
[str
]) – Authentication token to use the QiskitRuntimeService.
- class pytket.extensions.qiskit.tket_pass.TketPass(tket_pass)[source]¶
The tket compiler to be plugged in to the Qiskit compilation sequence
- __init__(tket_pass)[source]¶
Wraps a pytket compiler pass as a
qiskit.transpiler.TransformationPass
. Aqiskit.dagcircuit.DAGCircuit
is converted to a pytketCircuit
. tket_pass will be run and the result is converted back.- Parameters:
tket_pass (
BasePass
) – The pytket compiler pass to run
- run(dag)[source]¶
Run a preconfigured optimisation pass on the circuit and route for the given backend.
- Parameters:
dag (
DAGCircuit
) – The circuit to optimise and route- Return type:
- Returns:
The modified circuit
- class pytket.extensions.qiskit.tket_job.JobInfo(circuit_name, qbits, cbits, n_shots)[source]¶
- __init__(circuit_name, qbits, cbits, n_shots)¶
- class pytket.extensions.qiskit.tket_job.TketJob(backend, handles, jobinfos, final_maps)[source]¶
TketJob wraps a
ResultHandle
list as aqiskit.providers.JobV1