diff --git a/.github/workflows/docs/conf.py b/.github/workflows/docs/conf.py index 5ca01a33..4d0b97ef 100644 --- a/.github/workflows/docs/conf.py +++ b/.github/workflows/docs/conf.py @@ -33,7 +33,7 @@ # -- Extension configuration ------------------------------------------------- -pytketdoc_base = "https://cqcl.github.io/tket/pytket/api/" +pytketdoc_base = "https://tket.quantinuum.com/api-docs/" intersphinx_mapping = { "https://docs.python.org/3/": None, diff --git a/README.md b/README.md index 68491b16..9e7bb87c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # pytket-qiskit -[Pytket](https://cqcl.github.io/tket/pytket/api/index.html) is a python module for interfacing +[Pytket](https://tket.quantinuum.com/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 diff --git a/docs/changelog.rst b/docs/changelog.rst index 6d3ce6fb..e0aec580 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -56,7 +56,7 @@ unreleased 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/intro.txt b/docs/intro.txt index caa0e507..e2500595 100644 --- a/docs/intro.txt +++ b/docs/intro.txt @@ -122,15 +122,15 @@ and several types of simulator. * - Backend - Type - * - `IBMQBackend `_ + * - `IBMQBackend `_ - Interface to an IBM quantum computer. - * - `IBMQEmulatorBackend `_ + * - `IBMQEmulatorBackend `_ - Emulator for a chosen ``IBMBackend`` (Device specific). - * - `AerBackend `_ + * - `AerBackend `_ - A noiseless, shots-based simulator for quantum circuits [1] - * - `AerStateBackend `_ + * - `AerStateBackend `_ - Statevector simulator. - * - `AerUnitaryBackend `_ + * - `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`. @@ -148,37 +148,37 @@ Every :py:class:`Backend` in pytket has its own ``default_compilation_pass`` met * - optimisation_level = 0 - optimisation_level = 1 - optimisation_level = 2 [1] - * - `DecomposeBoxes `_ - - `DecomposeBoxes `_ - - `DecomposeBoxes `_ + * - `DecomposeBoxes `_ + - `DecomposeBoxes `_ + - `DecomposeBoxes `_ * - self.rebase_pass [2] - - `SynthesiseTket `_ - - `FullPeepholeOptimise `_ - * - `CXMappingPass `_ [3] - - `CXMappingPass `_ [3] - - `CXMappingPass `_ [3] - * - `NaivePlacementPass `_ - - `NaivePlacementPass `_ - - `NaivePlacementPass `_ + - `SynthesiseTket `_ + - `FullPeepholeOptimise `_ + * - `CXMappingPass `_ [3] + - `CXMappingPass `_ [3] + - `CXMappingPass `_ [3] + * - `NaivePlacementPass `_ + - `NaivePlacementPass `_ + - `NaivePlacementPass `_ * - self.rebase_pass [2] - - `SynthesiseTket `_ - - `KAKDecomposition(allow_swaps=False) `_ - * - `RemoveRedundancies `_ + - `SynthesiseTket `_ + - `KAKDecomposition(allow_swaps=False) `_ + * - `RemoveRedundancies `_ - self.rebase_pass [2] - - `CliffordSimp(allow_swaps=False) `_ + - `CliffordSimp(allow_swaps=False) `_ * - - - `RemoveRedundancies `_ - - `SynthesiseTket `_ + - `RemoveRedundancies `_ + - `SynthesiseTket `_ * - - - self.rebase_pass [2] * - - - - `RemoveRedundancies `_ + - `RemoveRedundancies `_ * [1] If no value is specified then ``optimisation_level`` defaults to a value of 2. * [2] self.rebase_pass is a rebase to the gateset supported by the backend, For IBM quantum devices that is {X, SX, Rz, CX}. -* [3] Here :py:class:`CXMappingPass` maps program qubits to the architecture using a `NoiseAwarePlacement `_ +* [3] Here :py:class:`CXMappingPass` maps program qubits to the architecture using a `NoiseAwarePlacement `_ **Note:** The ``default_compilation_pass`` for :py:class:`AerBackend` is the same as above. @@ -191,14 +191,14 @@ Circuits must satisfy certain conditions before they can be processed on a devic All ``pytket-qiskit`` backends have the following two predicates. -* `GateSetPredicate `_ - The circuit must contain only operations supported by the :py:class`Backend`. To view supported Ops run ``BACKENDNAME.backend_info.gate_set``. -* `NoSymbolsPredicate `_ - Parameterised gates must have numerical values when the circuit is executed. +* `GateSetPredicate `_ - The circuit must contain only operations supported by the :py:class`Backend`. To view supported Ops run ``BACKENDNAME.backend_info.gate_set``. +* `NoSymbolsPredicate `_ - Parameterised gates must have numerical values when the circuit is executed. The :py:class:`IBMQBackend` and :py:class:`IBMQEmulatorBackend` may also have the following predicates depending on the capabilities of the specified device. -* `NoClassicalControlPredicate `_ -* `NoMidMeasurePredicate `_ -* `NoFastFeedforwardPredicate `_ +* `NoClassicalControlPredicate `_ +* `NoMidMeasurePredicate `_ +* `NoFastFeedforwardPredicate `_ .. toctree:: api.rst diff --git a/pytket/extensions/qiskit/backends/ibm.py b/pytket/extensions/qiskit/backends/ibm.py index 4d68e90e..84de070e 100644 --- a/pytket/extensions/qiskit/backends/ibm.py +++ b/pytket/extensions/qiskit/backends/ibm.py @@ -375,7 +375,7 @@ def default_compilation_pass( passlist = [DecomposeBoxes()] # If you make changes to the default_compilation_pass, # then please update this page accordingly - # https://cqcl.github.io/pytket-qiskit/api/index.html#default-compilation + # https://tket.quantinuum.com/extensions/pytket-qiskit/api/index.html#default-compilation # Edit this docs source file -> pytket-qiskit/docs/intro.txt if optimisation_level == 0: if self._supports_rz: diff --git a/pytket/extensions/qiskit/tket_backend.py b/pytket/extensions/qiskit/tket_backend.py index 80cd3df3..c1b028c0 100644 --- a/pytket/extensions/qiskit/tket_backend.py +++ b/pytket/extensions/qiskit/tket_backend.py @@ -61,7 +61,7 @@ class TketBackend(QiskitBackend): :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 cad34c93..a73abd8b 100644 --- a/setup.py +++ b/setup.py @@ -32,7 +32,7 @@ author_email="tket-support@cambridgequantum.com", python_requires=">=3.9", project_urls={ - "Documentation": "https://cqcl.github.io/pytket-qiskit/api/index.html", + "Documentation": "https://tket.quantinuum.com/extensions/pytket-qiskit/api/index.html", "Source": "https://github.com/CQCL/pytket-qiskit", "Tracker": "https://github.com/CQCL/pytket-qiskit/issues", },