Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update some links #402

Closed
wants to merge 6 commits into from
Closed

docs: update some links #402

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f57afbb
latest theming commit
CalMacCQ Oct 15, 2024
c8acecc
use docs.quantinuum.com/tket
CalMacCQ Oct 15, 2024
8810ecf
fix incorrect AutoRebase links
CalMacCQ Oct 15, 2024
85d482f
resolve AutoRebase link warning
CalMacCQ Oct 15, 2024
b84ffc2
fix url
CalMacCQ Oct 15, 2024
561abc3
shorten docstring for pylint
CalMacCQ Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
[![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)](https://tketusers.slack.com/join/shared_invite/zt-18qmsamj9-UqQFVdkRzxnXCcKtcarLRA#)
[![Stack Exchange](https://img.shields.io/badge/StackExchange-%23ffffff.svg?style=for-the-badge&logo=StackExchange)](https://quantumcomputing.stackexchange.com/tags/pytket)

[Pytket](https://tket.quantinuum.com/api-docs/index.html) is a python module for interfacing
[Pytket](https://docs.quantinuum.com/tket/api-docs/index.html) is a python module for interfacing
with tket, a quantum computing toolkit and optimising compiler developed by Quantinuum.

`pytket-qiskit` is an extension to `pytket` that allows `pytket` circuits to be
run on IBM backends and simulators, as well as conversion to and from Qiskit
representations.

Some useful links:
- [API Documentation](https://tket.quantinuum.com/extensions/pytket-qiskit/)
- [API Documentation](https://docs.quantinuum.com/tket/extensions/pytket-qiskit/)

## Getting started

Expand Down
2 changes: 1 addition & 1 deletion docs/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ Changelog
0.40.0 (June 2023)
------------------

* IBM devices are now accessed using the `qiskit-ibm-provider <https://github.com/Qiskit/qiskit-ibm-provider>`_ instead of the deprecated :py:class:`IBMQ`. This allows the newest IBM devices and simulators to be accessed through ``pytket-qiskit``. See the updated documentation on `credentials <https://tket.quantinuum.com/extensions/pytket-qiskit/index.html#access-and-credentials>`_.
* IBM devices are now accessed using the `qiskit-ibm-provider <https://github.com/Qiskit/qiskit-ibm-provider>`_ instead of the deprecated :py:class:`IBMQ`. This allows the newest IBM devices and simulators to be accessed through ``pytket-qiskit``. See the updated documentation on `credentials <https://docs.quantinuum.com/tket/extensions/pytket-qiskit/index.html#access-and-credentials>`_.
* The parameters ``hub``, ``group`` and ``project`` are no longer handled as separate arguments in :py:class:`IBMQBackend` and :py:meth:`IBMQBackend.available_devices`. Use ``"instance=f"{hub}/{group}/{project}"`` instead.
* Added support for the {X, SX, Rz, ECR} in the default compilation pass for :py:class:`IBMQBackend` and :py:class:`IBMQEmulatorBackend`. This is the set of gates used by some of the new IBM devices.
* Fix to the :py:meth:`tk_to_qiskit` converter to prevent cancellation of redundant gates when converting to qiskit.
Expand Down
49 changes: 26 additions & 23 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,33 +166,33 @@ Every :py:class:`~pytket.backends.backend.Backend` in pytket has its own :py:met
* - optimisation_level = 0
- optimisation_level = 1
- optimisation_level = 2 [1]
* - `DecomposeBoxes <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.DecomposeBoxes>`_
- `DecomposeBoxes <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.DecomposeBoxes>`_
- `DecomposeBoxes <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.DecomposeBoxes>`_
* - `AutoRebase <https://tket.quantinuum.com/api-docs/placement.html#pytket.passes.AutoRebase>`_ [2]
- `SynthesiseTket <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.SynthesiseTket>`_
- `FullPeepholeOptimise <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.FullPeepholeOptimise>`_
* - `CXMappingPass <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.CXMappingPass>`_ [3]
- `CXMappingPass <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.CXMappingPass>`_ [3]
- `CXMappingPass <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.CXMappingPass>`_ [3]
* - `NaivePlacementPass <https://tket.quantinuum.com/api-docs/placement.html#pytket.passes.NaivePlacementPass>`_
- `NaivePlacementPass <https://tket.quantinuum.com/api-docs/placement.html#pytket.passes.NaivePlacementPass>`_
- `NaivePlacementPass <https://tket.quantinuum.com/api-docs/placement.html#pytket.passes.NaivePlacementPass>`_
* - `AutoRebase <https://tket.quantinuum.com/api-docs/placement.html#pytket.passes.AutoRebase>`_ [2]
- `SynthesiseTket <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.SynthesiseTket>`_
- `KAKDecomposition(allow_swaps=False) <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.KAKDecomposition>`_
* - `RemoveRedundancies <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.RemoveRedundancies>`_
- `AutoRebase <https://tket.quantinuum.com/api-docs/placement.html#pytket.passes.AutoRebase>`_ [2]
- `CliffordSimp(allow_swaps=False) <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.CliffordSimp>`_
* - `DecomposeBoxes <https://docs.quantinuum.com/tket/api-docs/passes.html#pytket.passes.DecomposeBoxes>`_
- `DecomposeBoxes <https://docs.quantinuum.com/tket/api-docs/passes.html#pytket.passes.DecomposeBoxes>`_
- `DecomposeBoxes <https://docs.quantinuum.com/tket/api-docs/passes.html#pytket.passes.DecomposeBoxes>`_
* - `AutoRebase`_ [2]
- `SynthesiseTket <https://docs.quantinuum.com/tket/api-docs/passes.html#pytket.passes.SynthesiseTket>`_
- `FullPeepholeOptimise <https://docs.quantinuum.com/tket/api-docs/passes.html#pytket.passes.FullPeepholeOptimise>`_
* - `CXMappingPass <https://docs.quantinuum.com/tket/api-docs/passes.html#pytket.passes.CXMappingPass>`_ [3]
- `CXMappingPass <https://docs.quantinuum.com/tket/api-docs/passes.html#pytket.passes.CXMappingPass>`_ [3]
- `CXMappingPass <https://docs.quantinuum.com/tket/api-docs/passes.html#pytket.passes.CXMappingPass>`_ [3]
* - `NaivePlacementPass <https://docs.quantinuum.com/tket/api-docs/placement.html#pytket.passes.NaivePlacementPass>`_
- `NaivePlacementPass <https://docs.quantinuum.com/tket/api-docs/placement.html#pytket.passes.NaivePlacementPass>`_
- `NaivePlacementPass <https://docs.quantinuum.com/tket/api-docs/placement.html#pytket.passes.NaivePlacementPass>`_
* - `AutoRebase <https://docs.quantinuum.com/tket/api-docs/passes.html#pytket.passes.AutoRebase>`_ [2]
- `SynthesiseTket <https://docs.quantinuum.com/tket/api-docs/passes.html#pytket.passes.SynthesiseTket>`_
- `KAKDecomposition(allow_swaps=False) <https://docs.quantinuum.com/tket/api-docs/passes.html#pytket.passes.KAKDecomposition>`_
* - `RemoveRedundancies <https://docs.quantinuum.com/tket/api-docs/passes.html#pytket.passes.RemoveRedundancies>`_
- `AutoRebase`_ [2]
- `CliffordSimp(allow_swaps=False) <https://docs.quantinuum.com/tket/api-docs/passes.html#pytket.passes.CliffordSimp>`_
* -
- `RemoveRedundancies <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.RemoveRedundancies>`_
- `SynthesiseTket <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.SynthesiseTket>`_
- `RemoveRedundancies <https://docs.quantinuum.com/tket/api-docs/passes.html#pytket.passes.RemoveRedundancies>`_
- `SynthesiseTket <https://docs.quantinuum.com/tket/api-docs/passes.html#pytket.passes.SynthesiseTket>`_
* -
-
- `AutoRebase <https://tket.quantinuum.com/api-docs/placement.html#pytket.passes.AutoRebase>`_ [2]
- `AutoRebase`_ [2]
* -
-
- `RemoveRedundancies <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.RemoveRedundancies>`_
- `RemoveRedundancies <https://docs.quantinuum.com/tket/api-docs/passes.html#pytket.passes.RemoveRedundancies>`_

* [1] If no value is specified then ``optimisation_level`` defaults to a value of 2.
* [2] :py:class:`~pytket._tket.passes.AutoRebase` is a conversion to the gateset supported by the backend. For IBM quantum devices and emulators the supported gateset is either :math:`\{X, SX, Rz, CX\}`, :math:`\{X, SX, Rz, ECR\}`, or :math:`\{X, SX, Rz, CZ\}`. The more idealised Aer simulators have a much broader range of supported gates.
Expand All @@ -217,7 +217,7 @@ Using TKET directly on qiskit circuits
======================================
.. currentmodule:: pytket.extensions.qiskit

For usage of :py:class:`~tket_backend.TketBackend` see the `qiskit integration notebook example <https://tket.quantinuum.com/user-guide/examples/backends/qiskit_integration.html>`_.
For usage of :py:class:`~tket_backend.TketBackend` see the `qiskit integration notebook example <https://docs.quantinuum.com/tket/user-guide/examples/backends/qiskit_integration.html>`_.

.. autosummary::
:nosignatures:
Expand All @@ -238,3 +238,6 @@ For usage of :py:class:`~tket_backend.TketBackend` see the `qiskit integration n

Issue tracker <https://github.com/CQCL/pytket-qiskit/issues>
PyPi <https://pypi.org/project/pytket-qiskit/>


.. _AutoRebase: https://docs.quantinuum.com/tket/api-docs/passes.html#pytket.passes.AutoRebase
2 changes: 1 addition & 1 deletion docs/pytket-docs-theming
Open in desktop
Submodule pytket-docs-theming updated 4 files
+2 −2 README.md
+43 −40 _static/nav-config.js
+21 −11 conf.py
+1 −1 quantinuum-sphinx
2 changes: 1 addition & 1 deletion pytket/extensions/qiskit/backends/ibm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ def default_compilation_pass_offline(
passlist = [DecomposeBoxes()]
# If you make changes to the default_compilation_pass,
# then please update this page accordingly
# https://tket.quantinuum.com/extensions/pytket-qiskit/index.html#default-compilation
# https://docs.quantinuum.com/tket/extensions/pytket-qiskit/index.html#default-compilation
# Edit this docs source file -> pytket-qiskit/docs/intro.txt
if optimisation_level == 0:
if supports_rz:
Expand Down
6 changes: 3 additions & 3 deletions pytket/extensions/qiskit/tket_backend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ class TketBackend(BackendV2):
:py:class:`qiskit.aqua.QuantumInstance`, providing a custom
:py:class:`qiskit.transpiler.PassManager` with a
:py:class:`qiskit.transpiler.passes.Unroller`. For examples, see the `user manual
<https://tket.quantinuum.com/user-manual/manual_backend.html#embedding-into-
qiskit>`_ or the `Qiskit integration example <ht
tps://github.com/CQCL/pytket/blob/main/examples/qiskit_integration. ipynb>`_.
<https://docs.quantinuum.com/tket/user-guide/manual/manual_backend.html#embedding-into-
Copy link
Contributor Author

@CalMacCQ CalMacCQ Oct 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

linting check is failing becuse therse lines are too long. Should we disable the linting for this line @cqc-melf ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These links were not clickable to begin with it seems.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should be possible to have the links on multiple line with adding \ at the end of the line? Have you tried that?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think just using a new line works. The link will not be clickable in the source file but sphinx produces a valid link in the html pages.

qiskit>`_ or the `Qiskit integration example <https://docs.quantinuum.com/tket/user-
guide/examples/backends/qiskit_integration.html>`_.
"""

def __init__(self, backend: Backend, comp_pass: Optional[BasePass] = None):
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
author_email="[email protected]",
python_requires=">=3.10",
project_urls={
"Documentation": "https://tket.quantinuum.com/extensions/pytket-qiskit/index.html",
"Documentation": "https://docs.quantinuum.com/tket/extensions/pytket-qiskit/index.html",
"Source": "https://github.com/CQCL/pytket-qiskit",
"Tracker": "https://github.com/CQCL/pytket-qiskit/issues",
},
Expand Down