Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/cqcl/pytket-cutensornet

cuTensorNet Python API extensions for pytket quantum SDK

https://github.com/cqcl/pytket-cutensornet

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.8%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

cuTensorNet Python API extensions for pytket quantum SDK

Basic Info
  • Host: GitHub
  • Owner: CQCL
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Size: 3.09 MB
Statistics
  • Stars: 15
  • Watchers: 8
  • Forks: 2
  • Open Issues: 11
  • Releases: 21
Created about 3 years ago · Last pushed 10 months ago
Metadata Files
Readme License

README.md

pytket-cutensornet

Slack Stack Exchange

Pytket is a python module for interfacing with tket, a quantum computing toolkit and optimising compiler developed by Quantinuum.

cuTensorNet is a high-performance library for tensor network computations, developed by NVIDIA. It is part of the cuQuantum SDK - a high-performance library aimed at quantum circuit simulations on the NVIDIA GPUs.

pytket-cutensornet is an extension to pytket that allows pytket circuits and expectation values to be simulated using cuTensorNet via an interface to cuQuantum Python.

Some useful links: - API Documentation

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 (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:

shell 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.

Bugs, support and feature requests

Please file bugs and feature requests on the Github issue tracker.

Development

To install an extension in editable mode, from its root folder run:

shell pip install -e .

Contributing

Pull requests are welcome. To make a PR, first fork the repo, make your proposed changes on the main branch, and open a PR from your fork. If it passes tests and is accepted after review, it will be merged in.

Code style

Docstrings

We use the Google style docstrings, please see this page for reference.

Type annotation

On the CI, mypy is used as a static type checker and all submissions must pass its checks. You should therefore run mypy locally on any changed files before submitting a PR. Because of the way extension modules embed themselves into the pytket namespace this is a little complicated, but it should be sufficient to run the script mypy-check and passing as a single argument the root directory of the module to test. The directory path should end with a /. For example, to run mypy on all Python files in this repository, when in the root folder, run:

shell ./mypy-check ./ The script requires mypy 0.800 or above.

Linting

We use pylint on the CI to check compliance with a set of style requirements (listed in .pylintrc). You should run pylint over any changed files before submitting a PR, to catch any issues.

Tests

To run the tests for a module:

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.

Owner

  • Name: Cambridge Quantum
  • Login: CQCL
  • Kind: organization
  • Location: Cambridge, UK

Quantum Software and Technologies

GitHub Events

Total
  • Create event: 51
  • Release event: 5
  • Issues event: 22
  • Watch event: 4
  • Delete event: 32
  • Member event: 1
  • Issue comment event: 37
  • Push event: 128
  • Pull request review comment event: 18
  • Pull request review event: 55
  • Pull request event: 90
  • Fork event: 1
Last Year
  • Create event: 51
  • Release event: 5
  • Issues event: 22
  • Watch event: 4
  • Delete event: 32
  • Member event: 1
  • Issue comment event: 37
  • Push event: 128
  • Pull request review comment event: 18
  • Pull request review event: 55
  • Pull request event: 90
  • Fork event: 1

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 36
  • Total pull requests: 244
  • Average time to close issues: 3 months
  • Average time to close pull requests: 16 days
  • Total issue authors: 9
  • Total pull request authors: 11
  • Average comments per issue: 0.75
  • Average comments per pull request: 0.47
  • Merged pull requests: 181
  • Bot issues: 0
  • Bot pull requests: 66
Past Year
  • Issues: 11
  • Pull requests: 87
  • Average time to close issues: 7 days
  • Average time to close pull requests: 15 days
  • Issue authors: 5
  • Pull request authors: 7
  • Average comments per issue: 0.09
  • Average comments per pull request: 0.41
  • Merged pull requests: 49
  • Bot issues: 0
  • Bot pull requests: 35
View more stats
Top Authors
Issue Authors
  • PabloAndresCQ (22)
  • jake-arkinstall (5)
  • erinaldiq (2)
  • CalMacCQ (2)
  • marcosdiezgarcia (1)
  • yapolyak (1)
  • cqc-alec (1)
  • NathanCQC (1)
  • obackhouse (1)
Pull Request Authors
  • PabloAndresCQ (101)
  • dependabot[bot] (66)
  • cqc-melf (36)
  • yapolyak (14)
  • cqc-alec (9)
  • CalMacCQ (6)
  • jake-arkinstall (4)
  • NathanCQC (3)
  • sjdilkes (2)
  • obackhouse (1)
  • willsimmons1465 (1)
Top Labels
Issue Labels
enhancement (6) bug (3) documentation (3) meta (2)
Pull Request Labels
dependencies (66) github_actions (42) python (24)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 3,515 last-month
  • Total docker downloads: 36
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 20
  • Total maintainers: 2
pypi.org: pytket-cutensornet

Extension for pytket, providing access to the cuTensorNet Python API.

  • Versions: 20
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 3,515 Last month
  • Docker Downloads: 36
Rankings
Docker downloads count: 3.3%
Dependent packages count: 10.0%
Downloads: 19.2%
Average: 19.3%
Dependent repos count: 21.7%
Forks count: 29.8%
Stargazers count: 31.9%
Maintainers (2)
cqc-melf PabloAndresCQ
Last synced: 10 months ago

Dependencies

.github/workflows/build_and_test.yml actions
  • actions/checkout v3 composite
  • actions/deploy-pages v2 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • actions/upload-pages-artifact v1 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/docs.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
.github/workflows/lint.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
lint-requirements.txt pypi
  • black *
  • pylint *
setup.py pypi
  • pytket *
tests/test-requirements.txt pypi
  • pytest * test
  • pytest-lazy-fixture * test
.github/workflows/build-with-nix.yml actions
  • actions/checkout v4 composite
  • cachix/cachix-action v15 composite
  • cachix/install-nix-action V28 composite
.github/workflows/check-examples.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • dorny/paths-filter v3 composite
.github/workflows/issue-to-project.yml actions
  • actions/add-to-project v1.0.2 composite