Skip to content

Commit

Permalink
update all links to the user manual (#1119)
Browse files Browse the repository at this point in the history
  • Loading branch information
CalMacCQ authored Nov 10, 2023
1 parent e5e0c3b commit 8eecdfa
Show file tree
Hide file tree
Showing 11 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion pytket/docs/backends.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ There are several `example notebooks <https://tket.quantinuum.com/examples>`_ on

Notebook tutorials specific to the :py:class:`QuantinuumBackend` can be found `here <https://github.com/CQCL/pytket-quantinuum/tree/develop/examples>`_.

See also the `Running on backends <https://cqcl.github.io/pytket/manual/manual_backend.html>`_ section of the pytket user manual.
See also the `Running on backends <https://tket.quantinuum.com/user-manual/manual_backend.html>`_ section of the pytket user manual.

.. automodule:: pytket.backends
:members: backend
Expand Down
2 changes: 1 addition & 1 deletion pytket/docs/circuit_class.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://cqcl.github.io/pytket/manual/manual_circuit.html>`_ for a step-by-step tutorial on constructing circuits.
See the `pytket User Manual <https://tket.quantinuum.com/user-manual/manual_circuit.html>`_ for a step-by-step tutorial on constructing circuits.

See also the notebook tutorials on `circuit generation <https://github.com/CQCL/pytket/blob/main/examples/circuit_generation_example.ipynb>`_ and `circuit analysis <https://github.com/CQCL/pytket/blob/main/examples/circuit_analysis_example.ipynb>`_.

Expand Down
2 changes: 1 addition & 1 deletion pytket/docs/classical.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
pytket.circuit.logic_exp
========================

For more discussion of classical logic in pytket see the `manual section <https://cqcl.github.io/pytket/manual/manual_circuit.html#classical-and-conditional-operations>`_.
For more discussion of classical logic in pytket see the `manual section <https://tket.quantinuum.com/user-manual/manual_circuit.html#classical-and-conditional-operations>`_.

.. automodule:: pytket.circuit.logic_exp
:members:
4 changes: 2 additions & 2 deletions pytket/docs/faqs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ 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 <https://cqcl.github.io/pytket/manual/manual_compiler.html#rebases>`_ for examples.
See the manual section on `rebases <https://tket.quantinuum.com/user-manual/manual_compiler.html#rebases>`_ for examples.

Unitary Synthesis
-----------------
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 <https://cqcl.github.io/pytket/manual/manual_circuit.html#boxes-for-unitary-synthesis>`_ .
See the manual section on `unitary synthesis <https://tket.quantinuum.com/user-manual/manual_circuit.html#boxes-for-unitary-synthesis>`_ .


Qiskit to TKET Conversion
Expand Down
4 changes: 2 additions & 2 deletions pytket/docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Or, if an extension module like ``pytket-qiskit`` is installed:
c = qiskit_to_tk(qc)

See the
`pytket user manual <https://cqcl.github.io/pytket/manual/index.html>`_
`pytket user manual <https://tket.quantinuum.com/user-manual/index.html>`_
for an extensive tutorial on pytket, providing a gentle introduction to its
features and how to run circuits on backend devices, with worked examples.

Expand Down Expand Up @@ -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 <https://cqcl.github.io/pytket-qiskit/api/index.html#default-compilation>`_ 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 <https://cqcl.github.io/pytket/manual/manual_compiler.html>`_ and the corresponding `notebook example <https://github.com/CQCL/pytket/blob/main/examples/compilation_example.ipynb>`_ for more.
See the section of the user manual on `circuit compilation <https://tket.quantinuum.com/user-manual/manual_compiler.html>`_ and the corresponding `notebook example <https://github.com/CQCL/pytket/blob/main/examples/compilation_example.ipynb>`_ for more.
4 changes: 2 additions & 2 deletions pytket/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://cqcl.github.io/pytket/manual/index.html>`_ 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 <https://tket.quantinuum.com/user-manual/index.html>`_ for an extensive introduction to ``pytket`` functionality and how to use it.

Extensions
~~~~~~~~~~
Expand Down Expand Up @@ -86,7 +86,7 @@ Licensed under the `Apache 2 License <http://www.apache.org/licenses/LICENSE-2.0
.. toctree::
:caption: More Documentation:

Manual <https://cqcl.github.io/pytket/manual/index.html>
Manual <https://tket.quantinuum.com/user-manual/>
extensions_index.rst
Example notebooks <https://tket.quantinuum.com/examples>

Expand Down
2 changes: 1 addition & 1 deletion pytket/docs/passes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Also there are special purpose passes such as `OptimisePhaseGadgets <https://cqc

Rebase passes can be used to convert a circuit to a desired gateset. See `RebaseCustom <https://cqcl.github.io/tket/pytket/api/passes.html#pytket.passes.RebaseCustom>`_ and `auto_rebase_pass <https://cqcl.github.io/tket/pytket/api/passes.html#module-pytket.passes.auto_rebase>`_.

For more on pytket passes see the `compilation <https://cqcl.github.io/pytket/manual/manual_compiler.html>`_ section of the user manual or the `notebook tutorials <https://tket.quantinuum.com/examples>`_
For more on pytket passes see the `compilation <https://tket.quantinuum.com/user-manual/manual_compiler.html>`_ section of the user manual or the `notebook tutorials <https://tket.quantinuum.com/examples>`_


.. automodule:: pytket._tket.passes
Expand Down
2 changes: 1 addition & 1 deletion pytket/docs/placement.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/CQCL/pytket/blob/main/examples/mapping_example.ipynb>`_ tutorial and the corresponding entry in the `user manual <https://cqcl.github.io/pytket/manual/manual_compiler.html#placement>`_.
For more on qubit placement (and routing in general) see the `qubit mapping <https://github.com/CQCL/pytket/blob/main/examples/mapping_example.ipynb>`_ tutorial and the corresponding entry in the `user manual <https://tket.quantinuum.com/user-manual/manual_compiler.html#placement>`_.

.. automodule:: pytket._tket.placement
:members:
Expand Down
2 changes: 1 addition & 1 deletion pytket/docs/predicates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://cqcl.github.io/pytket/manual/manual_compiler.html#predicates>`_. See also the `Compilation example <https://github.com/CQCL/pytket/blob/main/examples/compilation_example.ipynb>`_ notebook.
For more on predicates read the corresponding section of the `user manual <https://tket.quantinuum.com/user-manual/manual_compiler.html#predicates>`_. See also the `Compilation example <https://github.com/CQCL/pytket/blob/main/examples/compilation_example.ipynb>`_ notebook.

.. automodule:: pytket._tket.predicates
:members:
Expand Down
2 changes: 1 addition & 1 deletion pytket/docs/qasm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://cqcl.github.io/pytket/manual/manual_circuit.html#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 <https://tket.quantinuum.com/user-manual/manual_circuit.html#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
2 changes: 1 addition & 1 deletion pytket/package.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down

0 comments on commit 8eecdfa

Please sign in to comment.