From 8eecdfaad2e7aa96435320ba76ac02dc18e139bb Mon Sep 17 00:00:00 2001 From: CalMacCQ <93673602+CalMacCQ@users.noreply.github.com> Date: Fri, 10 Nov 2023 16:15:58 +0000 Subject: [PATCH] update all links to the user manual (#1119) --- pytket/docs/backends.rst | 2 +- pytket/docs/circuit_class.rst | 2 +- pytket/docs/classical.rst | 2 +- pytket/docs/faqs.rst | 4 ++-- pytket/docs/getting_started.rst | 4 ++-- pytket/docs/index.rst | 4 ++-- pytket/docs/passes.rst | 2 +- pytket/docs/placement.rst | 2 +- pytket/docs/predicates.rst | 2 +- pytket/docs/qasm.rst | 2 +- pytket/package.md | 2 +- 11 files changed, 14 insertions(+), 14 deletions(-) diff --git a/pytket/docs/backends.rst b/pytket/docs/backends.rst index ee0872b42d..758ac49a5b 100644 --- a/pytket/docs/backends.rst +++ b/pytket/docs/backends.rst @@ -7,7 +7,7 @@ There are several `example notebooks `_ on Notebook tutorials specific to the :py:class:`QuantinuumBackend` can be found `here `_. -See also the `Running on backends `_ section of the pytket user manual. +See also the `Running on backends `_ section of the pytket user manual. .. automodule:: pytket.backends :members: backend diff --git a/pytket/docs/circuit_class.rst b/pytket/docs/circuit_class.rst index 765dac404f..ea7da61904 100644 --- a/pytket/docs/circuit_class.rst +++ b/pytket/docs/circuit_class.rst @@ -2,7 +2,7 @@ pytket.circuit.Circuit ================================== :py:class:`Circuit` objects provide an abstraction of quantum circuits. They consist of a set of qubits/quantum wires and a collection of operations applied to them in a given order. These wires have open inputs and outputs, rather than assuming any fixed input state. -See the `Pytket User Manual `_ for a step-by-step tutorial on constructing circuits. +See the `pytket User Manual `_ for a step-by-step tutorial on constructing circuits. See also the notebook tutorials on `circuit generation `_ and `circuit analysis `_. diff --git a/pytket/docs/classical.rst b/pytket/docs/classical.rst index 92d9769201..9c67bf7c7b 100644 --- a/pytket/docs/classical.rst +++ b/pytket/docs/classical.rst @@ -1,7 +1,7 @@ pytket.circuit.logic_exp ======================== -For more discussion of classical logic in pytket see the `manual section `_. +For more discussion of classical logic in pytket see the `manual section `_. .. automodule:: pytket.circuit.logic_exp :members: \ No newline at end of file diff --git a/pytket/docs/faqs.rst b/pytket/docs/faqs.rst index fd485a7cb6..e8743a92ce 100644 --- a/pytket/docs/faqs.rst +++ b/pytket/docs/faqs.rst @@ -14,7 +14,7 @@ There are two types of rebase 2) :py:class:`RebaseCustom` - This can be used instead of `auto_rebase_pass` in cases where there is no hardcoded conversion available. In this case the user will have to specify how to implement TKET's {TK1, CX} or {TK1, TK2} operations in terms of the target :py:class:`OpType` s. -See the manual section on `rebases `_ for examples. +See the manual section on `rebases `_ for examples. Unitary Synthesis ----------------- @@ -22,7 +22,7 @@ Q: Can TKET generate a circuit to implement a unitary operator of my choice? A: Yes but only up to three qubits at present. This can be done with :py:class:`Unitary3qBox`. -See the manual section on `unitary synthesis `_ . +See the manual section on `unitary synthesis `_ . Qiskit to TKET Conversion diff --git a/pytket/docs/getting_started.rst b/pytket/docs/getting_started.rst index cdca6ef4b2..a6ea8e88b1 100644 --- a/pytket/docs/getting_started.rst +++ b/pytket/docs/getting_started.rst @@ -67,7 +67,7 @@ Or, if an extension module like ``pytket-qiskit`` is installed: c = qiskit_to_tk(qc) See the -`pytket user manual `_ +`pytket user manual `_ for an extensive tutorial on pytket, providing a gentle introduction to its features and how to run circuits on backend devices, with worked examples. @@ -109,4 +109,4 @@ The following code snippet will show how to compile a circuit to run on an IBM d Here the default compilation pass is applied by :py:meth:`IBMQBackend.get_compiled_circuit`. See `this page `_ for more details. As an alternative, We can experiment with constructing our own circuit compilation routines in pytket. Passes from the :py:mod:`pytket.passes` module can be applied individually or composed in sequence. -See the section of the user manual on `circuit compilation `_ and the corresponding `notebook example `_ for more. +See the section of the user manual on `circuit compilation `_ and the corresponding `notebook example `_ for more. diff --git a/pytket/docs/index.rst b/pytket/docs/index.rst index 57f3761305..9bbf64265f 100644 --- a/pytket/docs/index.rst +++ b/pytket/docs/index.rst @@ -19,7 +19,7 @@ If you have issues installing ``pytket`` please visit the `installation troubles To use ``pytket``, you can simply import the appropriate modules into your python code or in an interactive Python notebook. We can build circuits directly using the ``pytket`` interface by creating a blank circuit and adding gates in the order we want to apply them. See the `Getting Started`_ page for a basic tutorial on using -``pytket``. To get more in depth on features, see the `examples`_. See the `pytket user manual `_ for an extensive introduction to ``pytket`` functionality and how to use it. +``pytket``. To get more in depth on features, see the `examples`_. See the `pytket user manual `_ for an extensive introduction to ``pytket`` functionality and how to use it. Extensions ~~~~~~~~~~ @@ -86,7 +86,7 @@ Licensed under the `Apache 2 License + Manual extensions_index.rst Example notebooks diff --git a/pytket/docs/passes.rst b/pytket/docs/passes.rst index 8976af925e..5aee9536ef 100644 --- a/pytket/docs/passes.rst +++ b/pytket/docs/passes.rst @@ -9,7 +9,7 @@ Also there are special purpose passes such as `OptimisePhaseGadgets `_ and `auto_rebase_pass `_. -For more on pytket passes see the `compilation `_ section of the user manual or the `notebook tutorials `_ +For more on pytket passes see the `compilation `_ section of the user manual or the `notebook tutorials `_ .. automodule:: pytket._tket.passes diff --git a/pytket/docs/placement.rst b/pytket/docs/placement.rst index 61d0c4a6d9..d7b2184662 100644 --- a/pytket/docs/placement.rst +++ b/pytket/docs/placement.rst @@ -3,7 +3,7 @@ pytket.placement In order for the constraints of a :py:class:`Backend` to be solved we must first assign device qubits to device-independent (or program) qubits. This module contains three placement methods to perform such an assignment. -For more on qubit placement (and routing in general) see the `qubit mapping `_ tutorial and the corresponding entry in the `user manual `_. +For more on qubit placement (and routing in general) see the `qubit mapping `_ tutorial and the corresponding entry in the `user manual `_. .. automodule:: pytket._tket.placement :members: diff --git a/pytket/docs/predicates.rst b/pytket/docs/predicates.rst index e06702ad66..ee797a0aa7 100644 --- a/pytket/docs/predicates.rst +++ b/pytket/docs/predicates.rst @@ -3,7 +3,7 @@ pytket.predicates In pytket, predicates enforce properties of circuits. Each pytket :py:class:`Backend` has its own set of predicates which must be satisfied before a quantum circuit can be executed. There are predicates that enforce restrictions including gateset, number of qubits and classical control. -For more on predicates read the corresponding section of the `user manual `_. See also the `Compilation example `_ notebook. +For more on predicates read the corresponding section of the `user manual `_. See also the `Compilation example `_ notebook. .. automodule:: pytket._tket.predicates :members: diff --git a/pytket/docs/qasm.rst b/pytket/docs/qasm.rst index 16b42ab40a..bfd2123800 100644 --- a/pytket/docs/qasm.rst +++ b/pytket/docs/qasm.rst @@ -16,7 +16,7 @@ We can set the ``header`` argument in the qasm conversion functions as follows. qasm_str = circuit_to_qasm_str(circ, header="hqslib1") -.. note:: Unlike pytket backends, the qasm converters do not handle `implicit qubit permutations `_. In other words if a circuit containing an implicit qubit permutation is converted to a qasm file the implicit permutation will not be accounted for and the circuit will be missing this permutation when reimported. +.. note:: Unlike pytket backends, the qasm converters do not handle `implicit qubit permutations `_. In other words if a circuit containing an implicit qubit permutation is converted to a qasm file the implicit permutation will not be accounted for and the circuit will be missing this permutation when reimported. .. automodule:: pytket.qasm :members: circuit_from_qasm, circuit_from_qasm_wasm, circuit_to_qasm, circuit_from_qasm_str, circuit_to_qasm_str, circuit_from_qasm_io, circuit_to_qasm_io diff --git a/pytket/package.md b/pytket/package.md index 29b4a7f4d4..e3498fd6b5 100644 --- a/pytket/package.md +++ b/pytket/package.md @@ -27,7 +27,7 @@ official Python distribution instead. API reference: https://cqcl.github.io/tket/pytket/api/ -To get started using pytket see the [user manual](https://cqcl.github.io/pytket/manual/index.html). +To get started using pytket see the [user manual](https://tket.quantinuum.com/user-manual/). For worked examples using TKET see our [notebook examples](https://tket.quantinuum.com/examples).