Skip to content

Commit

Permalink
Updated README and requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
PabloAndresCQ committed Dec 10, 2024
1 parent 0d7edd0 commit b85db7c
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 14 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,22 @@ Some useful links:
## Getting started

`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/getting-started/index.html).
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 the `cuda-toolkit` before `pytket-cutensornet`; for instance,
in Ubuntu 24.04:

```shell
sudo apt install cuda-toolkit
pip install pytket-cutensornet
```

Alternatively, you may install `cuQuantum Python` following their installation
[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`.


## Bugs, support and feature requests

Please file bugs and feature requests on the Github
Expand Down Expand Up @@ -104,10 +109,10 @@ with a set of style requirements (listed in `.pylintrc`). You should run

To run the tests for a module:

1. `cd` into that module's `tests` directory;
2. ensure you have installed `pytest` and any other modules listed in
the `test-requirements.txt` file (all via `pip`);
3. run `pytest`.
```shell
pip install -r tests/test-requirements.txt
pytest tests/
```

When adding a new feature, please add a test for it. When fixing a bug, please
add a test that demonstrates the fix.
3 changes: 2 additions & 1 deletion lint-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
black~=24.10
pylint~=3.3
pylint~=3.3
mypy
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
license="Apache 2",
packages=find_namespace_packages(include=["pytket.*"]),
include_package_data=True,
install_requires=["pytket >= 1.34.0", "networkx >= 2.8.8"],
install_requires=["pytket >= 1.34.0", "networkx >= 2.8.8", "cuquantum-python>=24.11.0"],
classifiers=[
"Environment :: Console",
"Programming Language :: Python :: 3.10",
Expand Down
4 changes: 2 additions & 2 deletions tests/test-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
pytest
pytest-lazy-fixture
pytest==7.0
pytest-lazy-fixture

0 comments on commit b85db7c

Please sign in to comment.