From af97b9b40b9e8c3c0cd919475c0fc3e21012ade8 Mon Sep 17 00:00:00 2001 From: PabloAndresCQ Date: Wed, 11 Dec 2024 11:43:04 +0000 Subject: [PATCH] Updated installation instructions in docs --- README.md | 4 ++-- docs/index.rst | 15 ++++++++++----- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e970c50..ee8b5f0 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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`. diff --git a/docs/index.rst b/docs/index.rst index f42616a..6b3b879 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 `_) and first install ``cuQuantum Python`` following their installation -`instructions `_. -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 `_). +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 `_ +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