Merge pull request #118 from CQCL/release/pytket-1-23

Release 0.16.0

.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

@@ -33,7 +33,7 @@ jobs:
     - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* +refs/heads/*:refs/remotes/origin/*
     - name: Set up Python 3.9
       if: github.event_name == 'push' || github.event_name == 'schedule'
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: '3.9'
     - name: Build and test (3.9)
@@ -42,7 +42,7 @@ jobs:
       run: |
         ./.github/workflows/build-test nomypy
     - name: Set up Python 3.10
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: '3.10'
     - name: Build and test including remote checks (3.10) mypy
@@ -57,18 +57,18 @@ jobs:
         ./.github/workflows/build-test nomypy
     - name: Set up Python 3.11
       if: github.event_name == 'push' || github.event_name == 'pull_request' || github.event_name == 'schedule'
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: '3.11'
     - name: Build and test (3.11)
       if: github.event_name == 'push' || github.event_name == 'pull_request' || github.event_name == 'schedule'
       shell: bash
       run: |
         ./.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' )
@@ -87,9 +87,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
@@ -111,11 +115,11 @@ jobs:
       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
@@ -132,7 +136,7 @@ jobs:
         mkdir extensions
         ./build-docs -d ${GITHUB_WORKSPACE}/.github/workflows/docs/extensions/api
     - name: Upload docs as artefact
-      uses: actions/upload-pages-artifact@v2
+      uses: actions/upload-pages-artifact@v3
       with:
         path: .github/workflows/docs/extensions
 
@@ -150,4 +154,4 @@ jobs:
     steps:
     - name: Deploy to GitHub Pages
       id: deployment
-      uses: actions/deploy-pages@v2
+      uses: actions/deploy-pages@v4.0.1

.github/workflows/docs.yml

@@ -17,7 +17,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python 3.9
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: '3.9'
     - name: Upgrade pip and install wheel
@@ -34,7 +34,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/lint.yml

@@ -18,7 +18,7 @@ jobs:
     steps:
     - 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

@@ -2,7 +2,7 @@
 
 This repository contains the pytket-qujax extension, using CQC's
 [pytket](https://tket.quantinuum.com/api-docs/index.html) quantum SDK.
-The other pytket extensions can be found [here](https://tket.quantinuum.com/extensions/)
+The other pytket extensions can be found [here](https://tket.quantinuum.com/api-docs/extensions)
 
 [Pytket](https://tket.quantinuum.com/api-docs/index.html) is a Python module for interfacing
 with CQC tket, a set of quantum programming tools.
@@ -13,7 +13,7 @@ that allows [pytket](https://tket.quantinuum.com/api-docs/index.html) circuits t
 be converted to [qujax](https://github.com/CQCL/qujax) for fast (classical) simulation and automatic differentiation.
 
 Some useful links:
-- [Documentation](https://tket.quantinuum.com/extensions/pytket-qujax/api/index.html)
+- [Documentation](https://tket.quantinuum.com/extensions/pytket-qujax/index.html)
 - [PyPI](https://pypi.org/project/pytket-qujax/)
 - [qujax](https://github.com/CQCL/qujax)
 - [pytket-qujax example notebook (VQE)](https://github.com/CQCL/pytket/blob/main/examples/pytket-qujax_heisenberg_vqe.ipynb)

_metadata.py

@@ -1,2 +1,2 @@
-__extension_version__ = "0.15.0"
+__extension_version__ = "0.16.0"
 __extension_name__ = "pytket-qujax"

docs/changelog.rst

@@ -1,6 +1,11 @@
 Changelog
 ~~~~~~~~~
 
+0.16.0 (January 2024)
+---------------------
+
+* Updated pytket version requirement to 1.23.
+
 0.15.0 (November 2023)
 ----------------------
 

setup.py

@@ -32,7 +32,7 @@
     author_email="[email protected]",
     python_requires=">=3.9",
     project_urls={
-        "Documentation": "https://tket.quantinuum.com/extensions/pytket-qujax/api/index.html",
+        "Documentation": "https://tket.quantinuum.com/extensions/pytket-qujax/index.html",
         "Source": "https://github.com/CQCL/pytket-qujax",
         "Tracker": "https://github.com/CQCL/pytket-qujax/issues",
     },
@@ -43,7 +43,7 @@
     packages=find_namespace_packages(include=["pytket.*"]),
     include_package_data=True,
     install_requires=[
-        "pytket ~= 1.22",
+        "pytket ~= 1.23",
         "qujax ~= 1.0",
     ],
     classifiers=[