From f57afbba52f0609199fd16f71a4678ba90c1d432 Mon Sep 17 00:00:00 2001 From: CalMacCQ <93673602+CalMacCQ@users.noreply.github.com> Date: Tue, 15 Oct 2024 12:12:01 +0100 Subject: [PATCH 1/6] latest theming commit --- docs/pytket-docs-theming | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pytket-docs-theming b/docs/pytket-docs-theming index cfbe34c4..437d4987 160000 --- a/docs/pytket-docs-theming +++ b/docs/pytket-docs-theming @@ -1 +1 @@ -Subproject commit cfbe34c48f88c56085b8ef65f640d0108b8a9fa6 +Subproject commit 437d49873ee67c60e8c1e062bdfd6e58664ffc28 From c8aceccd8b5ad30bfd5f428bd34eef7b283407c4 Mon Sep 17 00:00:00 2001 From: CalMacCQ <93673602+CalMacCQ@users.noreply.github.com> Date: Tue, 15 Oct 2024 12:14:01 +0100 Subject: [PATCH 2/6] use docs.quantinuum.com/tket --- README.md | 4 +-- docs/changelog.rst | 2 +- docs/index.rst | 46 ++++++++++++------------ pytket/extensions/qiskit/backends/ibm.py | 2 +- pytket/extensions/qiskit/tket_backend.py | 2 +- setup.py | 2 +- 6 files changed, 29 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index b5ef1f87..7f781dc5 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![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 @@ -11,7 +11,7 @@ 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 diff --git a/docs/changelog.rst b/docs/changelog.rst index bd579469..421f5ddd 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -172,7 +172,7 @@ Changelog 0.40.0 (June 2023) ------------------ -* IBM devices are now accessed using the `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 `_. +* IBM devices are now accessed using the `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 `_. * 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. diff --git a/docs/index.rst b/docs/index.rst index 7d90f7da..31be3077 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 `_ - - `DecomposeBoxes `_ - - `DecomposeBoxes `_ - * - `AutoRebase `_ [2] - - `SynthesiseTket `_ - - `FullPeepholeOptimise `_ - * - `CXMappingPass `_ [3] - - `CXMappingPass `_ [3] - - `CXMappingPass `_ [3] - * - `NaivePlacementPass `_ - - `NaivePlacementPass `_ - - `NaivePlacementPass `_ - * - `AutoRebase `_ [2] - - `SynthesiseTket `_ - - `KAKDecomposition(allow_swaps=False) `_ - * - `RemoveRedundancies `_ - - `AutoRebase `_ [2] - - `CliffordSimp(allow_swaps=False) `_ + * - `DecomposeBoxes `_ + - `DecomposeBoxes `_ + - `DecomposeBoxes `_ + * - `AutoRebase `_ [2] + - `SynthesiseTket `_ + - `FullPeepholeOptimise `_ + * - `CXMappingPass `_ [3] + - `CXMappingPass `_ [3] + - `CXMappingPass `_ [3] + * - `NaivePlacementPass `_ + - `NaivePlacementPass `_ + - `NaivePlacementPass `_ + * - `AutoRebase `_ [2] + - `SynthesiseTket `_ + - `KAKDecomposition(allow_swaps=False) `_ + * - `RemoveRedundancies `_ + - `AutoRebase `_ [2] + - `CliffordSimp(allow_swaps=False) `_ * - - - `RemoveRedundancies `_ - - `SynthesiseTket `_ + - `RemoveRedundancies `_ + - `SynthesiseTket `_ * - - - - `AutoRebase `_ [2] + - `AutoRebase `_ [2] * - - - - `RemoveRedundancies `_ + - `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. @@ -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 `_. +For usage of :py:class:`~tket_backend.TketBackend` see the `qiskit integration notebook example `_. .. autosummary:: :nosignatures: diff --git a/pytket/extensions/qiskit/backends/ibm.py b/pytket/extensions/qiskit/backends/ibm.py index 8669ac32..5a94a498 100644 --- a/pytket/extensions/qiskit/backends/ibm.py +++ b/pytket/extensions/qiskit/backends/ibm.py @@ -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: diff --git a/pytket/extensions/qiskit/tket_backend.py b/pytket/extensions/qiskit/tket_backend.py index 47e598bd..aafba0ef 100644 --- a/pytket/extensions/qiskit/tket_backend.py +++ b/pytket/extensions/qiskit/tket_backend.py @@ -66,7 +66,7 @@ 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 - `_ or the `Qiskit integration example `_. """ diff --git a/setup.py b/setup.py index 7caed631..7c63f1bb 100644 --- a/setup.py +++ b/setup.py @@ -32,7 +32,7 @@ author_email="tket-support@quantinuum.com", 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", }, From 8810ecffb360fdc1adfc681a88bc44221ee0e731 Mon Sep 17 00:00:00 2001 From: CalMacCQ <93673602+CalMacCQ@users.noreply.github.com> Date: Tue, 15 Oct 2024 12:15:34 +0100 Subject: [PATCH 3/6] fix incorrect AutoRebase links --- docs/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 31be3077..274fd6fc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -178,18 +178,18 @@ Every :py:class:`~pytket.backends.backend.Backend` in pytket has its own :py:met * - `NaivePlacementPass `_ - `NaivePlacementPass `_ - `NaivePlacementPass `_ - * - `AutoRebase `_ [2] + * - `AutoRebase `_ [2] - `SynthesiseTket `_ - `KAKDecomposition(allow_swaps=False) `_ * - `RemoveRedundancies `_ - - `AutoRebase `_ [2] + - `AutoRebase `_ [2] - `CliffordSimp(allow_swaps=False) `_ * - - `RemoveRedundancies `_ - `SynthesiseTket `_ * - - - - `AutoRebase `_ [2] + - `AutoRebase `_ [2] * - - - `RemoveRedundancies `_ From 85d482f5b7918522c04189dbe92e7a0d13d82ee5 Mon Sep 17 00:00:00 2001 From: CalMacCQ <93673602+CalMacCQ@users.noreply.github.com> Date: Tue, 15 Oct 2024 12:19:53 +0100 Subject: [PATCH 4/6] resolve AutoRebase link warning --- docs/index.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 274fd6fc..2f096f42 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -169,7 +169,7 @@ Every :py:class:`~pytket.backends.backend.Backend` in pytket has its own :py:met * - `DecomposeBoxes `_ - `DecomposeBoxes `_ - `DecomposeBoxes `_ - * - `AutoRebase `_ [2] + * - `AutoRebase`_ [2] - `SynthesiseTket `_ - `FullPeepholeOptimise `_ * - `CXMappingPass `_ [3] @@ -182,14 +182,14 @@ Every :py:class:`~pytket.backends.backend.Backend` in pytket has its own :py:met - `SynthesiseTket `_ - `KAKDecomposition(allow_swaps=False) `_ * - `RemoveRedundancies `_ - - `AutoRebase `_ [2] + - `AutoRebase`_ [2] - `CliffordSimp(allow_swaps=False) `_ * - - `RemoveRedundancies `_ - `SynthesiseTket `_ * - - - - `AutoRebase `_ [2] + - `AutoRebase`_ [2] * - - - `RemoveRedundancies `_ @@ -238,3 +238,6 @@ For usage of :py:class:`~tket_backend.TketBackend` see the `qiskit integration n Issue tracker PyPi + + +.. _AutoRebase: https://docs.quantinuum.com/tket/api-docs/passes.html#pytket.passes.AutoRebase \ No newline at end of file From b84ffc28d863e0e4adac8fd94cb32c66942f73b8 Mon Sep 17 00:00:00 2001 From: CalMacCQ <93673602+CalMacCQ@users.noreply.github.com> Date: Tue, 15 Oct 2024 12:25:28 +0100 Subject: [PATCH 5/6] fix url --- pytket/extensions/qiskit/tket_backend.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/pytket/extensions/qiskit/tket_backend.py b/pytket/extensions/qiskit/tket_backend.py index aafba0ef..33db15ef 100644 --- a/pytket/extensions/qiskit/tket_backend.py +++ b/pytket/extensions/qiskit/tket_backend.py @@ -66,9 +66,8 @@ 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 - `_ or the `Qiskit integration example `_. + `_ or the `Qiskit integration example `_. """ def __init__(self, backend: Backend, comp_pass: Optional[BasePass] = None): From 561abc3e281b4227bad8c2e5bb55a5f4ebcd4dd7 Mon Sep 17 00:00:00 2001 From: CalMacCQ <93673602+CalMacCQ@users.noreply.github.com> Date: Mon, 21 Oct 2024 11:56:00 +0100 Subject: [PATCH 6/6] shorten docstring for pylint --- pytket/extensions/qiskit/tket_backend.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pytket/extensions/qiskit/tket_backend.py b/pytket/extensions/qiskit/tket_backend.py index 33db15ef..2d1127bf 100644 --- a/pytket/extensions/qiskit/tket_backend.py +++ b/pytket/extensions/qiskit/tket_backend.py @@ -67,7 +67,8 @@ class TketBackend(BackendV2): :py:class:`qiskit.transpiler.PassManager` with a :py:class:`qiskit.transpiler.passes.Unroller`. For examples, see the `user manual `_ or the `Qiskit integration example `_. + qiskit>`_ or the `Qiskit integration example `_. """ def __init__(self, backend: Backend, comp_pass: Optional[BasePass] = None):