Merge branch 'develop' into feature/ttn

.github/dependabot.yml

@@ -0,0 +1,16 @@
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: "daily"
+    groups:
+      python-packages:
+        patterns:
+          - "*"

.github/pull_request_template.md

@@ -0,0 +1,15 @@
+# Description
+
+Please summarise the changes.
+
+# Related issues
+
+Please mention any github issues addressed by this PR.
+
+# Checklist
+
+- [ ] I have performed a self-review of my code.
+- [ ] I have commented hard-to-understand parts of my code.
+- [ ] I have made corresponding changes to the public API documentation.
+- [ ] I have added tests that prove my fix is effective or that my feature works.
+- [ ] I have updated the changelog with any user-facing changes.

.github/workflows/build_and_test.yml

@@ -26,35 +26,46 @@ jobs:
         os: ['ubuntu-22.04', 'macos-12']
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         fetch-depth: '0'
     - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* +refs/heads/*:refs/remotes/origin/*
-    - name: Set up Python 3.9
-      uses: actions/setup-python@v4
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v5
       with:
-        python-version: '3.9'
-    - name: Build and mypy (3.9)
+        python-version: '3.10'
+    - name: Build and mypy (3.10)
       shell: bash
       if:  (matrix.os == 'macos-12') && (github.event_name == 'push' || (github.event_name == 'pull_request' &&  github.event.pull_request.head.repo.full_name == github.repository) || github.event_name == 'release' || github.event_name == 'schedule' )
       run: |
         chmod +x ./.github/workflows/build-test
         ./.github/workflows/build-test mypy
-    - name: Set up Python 3.10
+    - name: Set up Python 3.11
       if: github.event_name == 'push' || github.event_name == 'pull_request' || github.event_name == 'release' || github.event_name == 'schedule'
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
-        python-version: '3.10'
-    - name: Build (3.10)
+        python-version: '3.11'
+    - name: Build (3.11)
+      if: github.event_name == 'push' || github.event_name == 'pull_request' || github.event_name == 'release' || github.event_name == 'schedule'
+      shell: bash
+      run: |
+        chmod +x ./.github/workflows/build-test
+        ./.github/workflows/build-test nomypy
+    - name: Set up Python 3.12
+      if: github.event_name == 'push' || github.event_name == 'pull_request' || github.event_name == 'release' || github.event_name == 'schedule'
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+    - name: Build (3.12)
       if: github.event_name == 'push' || github.event_name == 'pull_request' || github.event_name == 'release' || github.event_name == 'schedule'
       shell: bash
       run: |
         chmod +x ./.github/workflows/build-test
         ./.github/workflows/build-test nomypy
-    - uses: actions/upload-artifact@v3
+    - uses: actions/upload-artifact@v4
       if: github.event_name == 'release' || contains(github.ref, 'refs/heads/wheel')
       with:
-        name: artefacts
+        name: artefact-${{ matrix.os }}
         path: wheelhouse/
     - name: Install docs dependencies
       if: (matrix.os == 'ubuntu-22.04') && (github.event_name == 'pull_request' || github.event_name == 'schedule' )
@@ -74,9 +85,13 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
     - name: Download all wheels
-      uses: actions/download-artifact@v3
+      # downloading all three files into the wheelhouse
+      # all files are identical, so there will only be one file
+      uses: actions/download-artifact@v4
       with:
         path: wheelhouse
+        pattern: artefact-*
+        merge-multiple: true
     - name: Put them all in the dist folder
       run: |
         mkdir dist
@@ -94,15 +109,15 @@ jobs:
     needs: publish_to_pypi
     runs-on: ubuntu-22.04
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         fetch-depth: '0'
     - name: Set up Python 3.10
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: '3.10'
     - name: Download all wheels
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         path: wheelhouse
     - name: Install pip, wheel
@@ -119,7 +134,7 @@ jobs:
         mkdir extensions
         ./build-docs -d ${GITHUB_WORKSPACE}/.github/workflows/docs/extensions/api
     - name: Upload docs as artefact
-      uses: actions/upload-pages-artifact@v1
+      uses: actions/upload-pages-artifact@v3
       with:
         path: .github/workflows/docs/extensions
 
@@ -137,4 +152,4 @@ jobs:
     steps:
     - name: Deploy to GitHub Pages
       id: deployment
-      uses: actions/deploy-pages@v2
+      uses: actions/deploy-pages@v4.0.3

.github/workflows/docs.yml

@@ -12,9 +12,9 @@ jobs:
     name: build docs
     runs-on: ubuntu-22.04
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python 3.10
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: '3.10'
     - name: Upgrade pip and install wheel
@@ -30,7 +30,7 @@ jobs:
         cd .github/workflows/docs
         mkdir extensions
         ./build-docs -d ${GITHUB_WORKSPACE}/.github/workflows/docs/extensions
-    - uses: actions/upload-artifact@v3
+    - uses: actions/upload-artifact@v4
       with:
         name: pytket-extension-docs
         path: .github/workflows/docs/extensions/

.github/workflows/docs/build-docs

@@ -10,8 +10,11 @@ import sys
 
 DOCS_DIR = Path(sys.argv[0]).absolute().parent
 MODULES_DIR = DOCS_DIR.parent.parent.parent
-PYTKET_DOCS_LINK = "https://cqcl.github.io/tket/pytket/api/index.html"
-PYTKET_EX_DOCS_LINK = "https://cqcl.github.io/pytket-extensions/api/index.html"
+TKET_EXAMPLES_LINK = "https://tket.quantinuum.com/examples/"
+TKET_MANUAL_LINK = "https://tket.quantinuum.com/user-manual/"
+TKET_WEBSITE_LINK = "https://tket.quantinuum.com/"
+PYTKET_DOCS_LINK = "https://tket.quantinuum.com/api-docs/"
+PYTKET_EX_DOCS_LINK = "https://tket.quantinuum.com/api-docs/extensions.html"
 PYTKET_QULACS_PYPI_LINK = "https://pypi.org/project/pytket-cutensornet/"
 PYTKET_QULACS_GITHUB = "https://github.com/CQCL/pytket-cutensornet"
 MODULE = "cutensornet"
@@ -49,10 +52,13 @@ def build_module_docs():
     with open(mod_docs / "intro.txt", "r") as f:
         content = f.readlines()
         content.append(
-            "\n.. toctree::\n\t:caption: More documentation:\n\t:maxdepth: 1\n\n"
+            "\n.. toctree::\n\t:caption: pytket documentation:\n\t:maxdepth: 1\n\n"
         )
-        content.append(f"\tpytket <{PYTKET_DOCS_LINK}>\n")
+        content.append(f"\tpytket API docs <{PYTKET_DOCS_LINK}>\n")
         content.append(f"\tpytket extensions <{PYTKET_EX_DOCS_LINK}>\n")
+        content.append(f"\tManual <{TKET_MANUAL_LINK}>\n")
+        content.append(f"\tExample notebooks <{TKET_EXAMPLES_LINK}>\n")
+        content.append(f"\tTKET website <{TKET_WEBSITE_LINK}>\n")
         content.append(
             "\n.. toctree::\n\t:caption: Links:\n\t:maxdepth: 1\n\n"
         )

.github/workflows/docs/conf.py

@@ -45,7 +45,7 @@
 
 # -- Extension configuration -------------------------------------------------
 
-pytketdoc_base = "https://cqcl.github.io/tket/pytket/api/"
+pytketdoc_base = "https://tket.quantinuum.com/api-docs/"
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3/", None),

.github/workflows/lint.yml

@@ -17,9 +17,9 @@ jobs:
     runs-on: ubuntu-22.04
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python 3.x
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: '3.x'
     - name: Update pip

README.md

@@ -1,17 +1,12 @@
-# Pytket Extensions
-
-This repository contains the pytket-cutensornet extension, using Quantinuum's
-[pytket](https://cqcl.github.io/tket/pytket/api/index.html) quantum SDK.
-
 # pytket-cutensornet
 
-[Pytket](https://cqcl.github.io/tket/pytket/api/index.html) is a python module for interfacing
-with tket, a quantum computing toolkit and optimisation compiler developed by Quantinuum.
+[Pytket](https://tket.quantinuum.com/api-docs/index.html) is a python module for interfacing
+with tket, a quantum computing toolkit and optimising compiler developed by Quantinuum.
 
 
-[cuTensorNet](https://docs.nvidia.com/cuda/cuquantum/cutensornet/index.html) is a
+[cuTensorNet](https://docs.nvidia.com/cuda/cuquantum/latest/cutensornet/index.html) is a
 high-performance library for tensor network computations, developed by NVIDIA.
-It is part of the [cuQuantum](https://docs.nvidia.com/cuda/cuquantum/index.html) SDK -
+It is part of the [cuQuantum](https://docs.nvidia.com/cuda/cuquantum/latest/index.html) SDK -
 a high-performance library aimed at quantum circuit simulations on the NVIDIA GPU chips,
 consisting of two major components:
  - `cuStateVec`: a high-performance library for state vector computations.
@@ -21,21 +16,24 @@ Both components have both C and Python API.
 
 `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](https://docs.nvidia.com/cuda/cuquantum/python/index.html).
+[cuQuantum Python](https://docs.nvidia.com/cuda/cuquantum/latest/cutensornet/index.html).
 
 Currently, only single-GPU calculations are supported, but a multi-GPU execution will be
 implemented in the due course using `mpi4py` library.
 
 ## Getting started
 
-`pytket-cutensornet` is available for Python 3.9, 3.10 and 3.11 on Linux.
-In order to use it, you need access to a Linux machine with either `Volta`, `Ampere`
-or `Hopper` GPU and first install `cuQuantum Python` following their installation
-[instructions](https://docs.nvidia.com/cuda/cuquantum/python/README.html#installation).
+`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:
 
-```pip install pytket-cutensornet```
+```shell
+pip install pytket-cutensornet
+```
 
 ## Bugs, support and feature requests
 

_metadata.py

@@ -1,2 +1,2 @@
-__extension_version__ = "0.4.0"
+__extension_version__ = "0.5.4"
 __extension_name__ = "pytket-cutensornet"

docs/changelog.rst

@@ -1,6 +1,23 @@
 Changelog
 ~~~~~~~~~
 
+0.5.4 (January 2024)
+--------------------
+
+* Updated pytket version requirement to 1.24.
+* Python 3.12 support added, 3.9 dropped.
+
+0.5.3 (January 2024)
+--------------------
+
+* Updated pytket version requirement to 1.23.
+
+0.5.2 (December 2023)
+---------------------
+
+* ``MPS`` simulation with fixed ``truncation_fidelity`` now uses the corresponding truncation primitive from cuQuantum (v23.10).
+* Updated pytket version requirement to 1.22.
+
 0.4.0 (October 2023)
 --------------------
 

docs/intro.txt

@@ -18,7 +18,7 @@ We provide two core functionalities:
 Currently, only single-GPU calculations are supported, but a multi-GPU execution will be
 implemented in the due course using ``mpi4py`` library.
 
-``pytket-cutensornet`` is available for Python 3.9, 3.10 and 3.11 on Linux.
+``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
@@ -30,4 +30,4 @@ This will include the necessary dependencies such as CUDA toolkit. Then, to inst
 
 .. toctree::
     api.rst
-    changelog.rst
+    changelog.rst

examples/mps_tutorial.ipynb

@@ -34,7 +34,7 @@
    "source": [
     "# Introduction\n",
     "\n",
-    "This notebook provides examples of the usage of the MPS functionalities of `pytket_cutensornet`. For more information, see the docs at https://cqcl.github.io/pytket-cutensornet/api/index.html.\n",
+    "This notebook provides examples of the usage of the MPS functionalities of `pytket_cutensornet`. For more information, see the docs at https://tket.quantinuum.com/extensions/pytket-cutensornet/api/index.html.\n",
     "\n",
     "A Matrix Product State (MPS) represents a state on `n` qubits as a list of `n` tensors connected in a line as show below:\n",
     "\n",

lint-requirements.txt

@@ -1,2 +1,2 @@
-black~=22.3
-pylint~=2.13,!=2.13.6
+black~=24.1
+pylint~=3.0

mypy.ini

@@ -1,5 +1,5 @@
 [mypy]
-python_version = 3.9
+python_version = 3.10
 warn_unused_configs = True
 
 disallow_untyped_decorators = False
@@ -25,4 +25,4 @@ ignore_errors = True
 
 [mypy-lark.*]
 ignore_missing_imports = True
-ignore_errors = True
+ignore_errors = True