Skip to content

Commit

Permalink
remove duplicate docs on Backends
Browse files Browse the repository at this point in the history
  • Loading branch information
CalMacCQ committed Feb 16, 2024
1 parent bb653cc commit f39f3c7
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 23 deletions.
5 changes: 4 additions & 1 deletion docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,9 @@ The circuit converters can also handle some higher level operations. Below we sh

Using TKET directly on qiskit circuits
--------------------------------------

For usage of :py:class:`TketBackend` see the `qiskit integration notebook example <https://tket.quantinuum.com/examples/qiskit_integration.html>`_.

.. currentmodule:: pytket.extensions.qiskit.tket_backend

.. autosummary::
Expand Down Expand Up @@ -121,7 +124,7 @@ IBM Credential Configuration
See also the docs on `Access and Credentials <file:///Users/callum/work_projects/pytket-qiskit/docs/build/index.html#access-and-credentials>`_.

.. currentmodule:: pytket.extensions.qiskit.backends.config

.. autosummary::
:nosignatures:

Expand Down
23 changes: 1 addition & 22 deletions docs/intro.txt
Original file line number Diff line number Diff line change
Expand Up @@ -112,29 +112,8 @@ To see which devices you can access you can use the ``available_devices`` method

Backends Available Through pytket-qiskit
========================================
See `this page <https://tket.quantinuum.com/extensions/pytket-qiskit/api.html#available-ibm-backends>`.

The ``pytket-qiskit`` extension has several types of available :py:class:`Backend`. These are the :py:class:`IBMQBackend`
and several types of simulator.

.. list-table::
:widths: 25 25
:header-rows: 1

* - Backend
- Type
* - `IBMQBackend <https://tket.quantinuum.com/extensions/pytket-qiskit/api.html#pytket.extensions.qiskit.IBMQBackend>`_
- Interface to an IBM quantum computer.
* - `IBMQEmulatorBackend <https://tket.quantinuum.com/extensions/pytket-qiskit/api.html#pytket.extensions.qiskit.IBMQEmulatorBackend>`_
- Emulator for a chosen ``IBMBackend`` (Device specific).
* - `AerBackend <https://tket.quantinuum.com/extensions/pytket-qiskit/api.html#pytket.extensions.qiskit.AerBackend>`_
- A noiseless, shots-based simulator for quantum circuits [1]
* - `AerStateBackend <https://tket.quantinuum.com/extensions/pytket-qiskit/api.html#pytket.extensions.qiskit.AerStateBackend>`_
- Statevector simulator.
* - `AerUnitaryBackend <https://tket.quantinuum.com/extensions/pytket-qiskit/api.html#pytket.extensions.qiskit.AerUnitaryBackend>`_
- Unitary simulator

* [1] :py:class:`AerBackend` is noiseless by default and has no architecture. However it can accept a user defined :py:class:`NoiseModel` and :py:class:`Architecture`.
* In addition to the backends above the ``pytket-qiskit`` extension also has the :py:class:`TketBackend`. This allows a tket :py:class:`Backend` to be used directly through qiskit. see the `notebook example <https://github.com/CQCL/pytket/blob/main/examples/qiskit_integration.ipynb>`_ on qiskit integration.

Default Compilation
===================
Expand Down

0 comments on commit f39f3c7

Please sign in to comment.