Skip to content

Commit

Permalink
Updated installation instructions in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
PabloAndresCQ committed Dec 11, 2024
1 parent 6f3dc53 commit af97b9b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Some useful links:
`pytket-cutensornet` is available for Python 3.10, 3.11 and 3.12 on Linux.
In order to use it, you need access to a Linux machine (or WSL) with an NVIDIA GPU of
Compute Capability +7.0 (check it [here](https://developer.nvidia.com/cuda-gpus)).
You will need to install the `cuda-toolkit` and `cuquantum-python` before `pytket-cutensornet`;
You will need to install `cuda-toolkit` and `cuquantum-python` before `pytket-cutensornet`;
for instance, in Ubuntu 24.04:

```shell
Expand All @@ -40,7 +40,7 @@ pip install cuquantum-python
pip install pytket-cutensornet
```

Alternatively, you may install `cuQuantum Python` following their installation
Alternatively, you may install cuQuantum Python following their
[instructions](https://docs.nvidia.com/cuda/cuquantum/latest/getting-started/index.html) using `conda-forge`.
This will include the necessary dependencies from CUDA toolkit. Then, you may install
`pytket-cutensornet` using `pip`.
Expand Down
15 changes: 10 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,20 @@ Currently, only single-GPU calculations are supported, but a multi-GPU execution
implemented in the due course using ``mpi4py`` library.

``pytket-cutensornet`` is available for Python 3.10, 3.11 and 3.12 on Linux.
In order to use it, you need access to a Linux machine with an NVIDIA GPU of Compute Capability +7.0 (check it `here <https://developer.nvidia.com/cuda-gpus>`_) and first install ``cuQuantum Python`` following their installation
`instructions <https://docs.nvidia.com/cuda/cuquantum/latest/python/README.html#installation>`_.
This will include the necessary dependencies such as CUDA toolkit. Then, to install
``pytket-cutensornet``, run:
In order to use it, you need access to a Linux machine (or WSL) with an NVIDIA GPU of
Compute Capability +7.0 (check it `here <https://developer.nvidia.com/cuda-gpus>`_).
You will need to install ``cuda-toolkit`` and ``cuquantum-python`` before ``pytket-cutensornet``;
for instance, in Ubuntu 24.04:

::

sudo apt install cuda-toolkit
pip install cuquantum-python
pip install pytket-cutensornet

Alternatively, you may install cuQuantum Python following their `instructions <https://docs.nvidia.com/cuda/cuquantum/latest/getting-started/index.html>`_
using ``conda-forge``. This will include the necessary dependencies from CUDA toolkit. Then, you may install
``pytket-cutensornet`` using ``pip``.

.. toctree::
api.rst
changelog.rst
Expand Down

0 comments on commit af97b9b

Please sign in to comment.