Merge pull request #1349 from CQCL/release/1.27.0

Release/1.27.0

.github/workflows/build-with-nix.yml

@@ -11,10 +11,14 @@ jobs:
   build_and_test:
     strategy:
       matrix:
-        os: ['ubuntu-22.04', 'macos-13-xlarge']
+        os: ['ubuntu-22.04', 'macos-14']
     runs-on: ${{matrix.os}}
     steps:
     - uses: actions/checkout@v4
     - uses: cachix/install-nix-action@v26
+    - uses: cachix/cachix-action@v14
+      with:
+        name: tket
+        authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
     - name: Build and test tket
       run: nix flake check -L

.github/workflows/build-without-conan.yml

@@ -74,9 +74,9 @@ jobs:
     - name: Install catch2
       run: |
         cd ${TMP_DIR}
-        wget https://github.com/catchorg/Catch2/archive/refs/tags/v3.5.2.tar.gz
-        tar xzvf v3.5.2.tar.gz
-        cd Catch2-3.5.2/
+        wget https://github.com/catchorg/Catch2/archive/refs/tags/v3.5.4.tar.gz
+        tar xzvf v3.5.4.tar.gz
+        cd Catch2-3.5.4/
         mkdir build
         cd build
         cmake -GNinja -DCMAKE_INSTALL_PREFIX=${INSTALL_DIR} ..
@@ -96,9 +96,9 @@ jobs:
     - name: Install pybind11
       run: |
         cd ${TMP_DIR}
-        wget https://github.com/pybind/pybind11/archive/refs/tags/v2.11.1.tar.gz
-        tar xzvf v2.11.1.tar.gz
-        cd pybind11-2.11.1/
+        wget https://github.com/pybind/pybind11/archive/refs/tags/v2.12.0.tar.gz
+        tar xzvf v2.12.0.tar.gz
+        cd pybind11-2.12.0/
         mkdir build
         cd build
         cmake -GNinja -DCMAKE_INSTALL_PREFIX=${INSTALL_DIR} -DPYBIND11_TEST=OFF ..

.github/workflows/build_and_test.yml

@@ -97,7 +97,7 @@ jobs:
     if: needs.check_changes.outputs.tket_or_workflow_changed == 'true'
     strategy:
       matrix:
-        os: ['ubuntu-22.04', 'macos-12', 'macos-13-xlarge']
+        os: ['ubuntu-22.04', 'macos-12', 'macos-14']
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v4
@@ -330,7 +330,7 @@ jobs:
     if: needs.check_changes.outputs.tket_or_workflow_changed == 'true' || needs.check_changes.outputs.pytket_or_workflow_changed == 'true'
     strategy:
       matrix:
-        os: ['macos-12', 'macos-13-xlarge']
+        os: ['macos-12', 'macos-14']
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v4
@@ -401,10 +401,9 @@ jobs:
         python -m pip install -r requirements.txt
         python -m pytest --ignore=simulator/
     - name: Check type stubs are up-to-date and run mypy
-      if: matrix.os == 'macos-13-xlarge' && (github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch')
+      if: matrix.os == 'macos-14' && (github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch')
       run: |
-        python -m pip install -U mypy
-        python -m pip install pybind11-stubgen==2.3.6 # https://github.com/CQCL/tket/issues/1135
+        python -m pip install -U mypy pybind11-stubgen
         cd pytket
         ./stub_generation/regenerate_stubs
         git diff --quiet pytket/_tket && echo "Stubs are up-to-date" || exit 1  # fail if stubs change after regeneration

.github/workflows/build_libs.yml

@@ -46,7 +46,7 @@ jobs:
     if: ${{ needs.changes.outputs.libs != '[]' && needs.changes.outputs.libs != '' }}
     strategy:
       matrix:
-        os: ['ubuntu-22.04', 'macos-12', 'windows-2022', 'macos-13-xlarge']
+        os: ['ubuntu-22.04', 'macos-12', 'windows-2022', 'macos-14']
         lib: ${{ fromJson(needs.changes.outputs.libs) }}
         build_type: ['Release', 'Debug']
     runs-on: ${{ matrix.os }}

.github/workflows/packages.yml

@@ -17,7 +17,7 @@ jobs:
     name: Build
     strategy:
       matrix:
-        os: ['ubuntu-22.04', 'macos-12', 'windows-2022', 'macos-13-xlarge']
+        os: ['ubuntu-22.04', 'macos-12', 'windows-2022', 'macos-14']
     runs-on: ${{ matrix.os }}
     steps:
 

.github/workflows/release.yml

@@ -62,8 +62,8 @@ jobs:
         name: Linux_aarch64_3.${{ matrix.python3-version }}_wheel
         path: wheelhouse/
 
-  build_macos_wheels:
-    name: Build macos wheels
+  build_macos_x86_wheels:
+    name: Build macos x86 wheels
     runs-on: macos-12
     strategy:
       matrix:
@@ -101,12 +101,12 @@ jobs:
         delocate-wheel -v -w "$GITHUB_WORKSPACE/wheelhouse/" "dist/pytket-"*".whl"
     - uses: actions/upload-artifact@v4
       with:
-        name: MacOS_${{ matrix.python-version }}_wheel
+        name: MacOS_x86_${{ matrix.python-version }}_wheel
         path: wheelhouse/
 
-  build_macos_M1_wheels:
-    name: Build macos (M1) wheels
-    runs-on: macos-13-xlarge
+  build_macos_arm64_wheels:
+    name: Build macos arm64 wheels
+    runs-on: macos-14
     strategy:
       matrix:
         python-version: ['3.10', '3.11', '3.12']
@@ -125,7 +125,7 @@ jobs:
       run: |
         conan profile detect
         DEFAULT_PROFILE_PATH=`conan profile path default`
-        PROFILE_PATH=./conan-profiles/macos-13-xlarge
+        PROFILE_PATH=./conan-profiles/macos-14
         diff ${DEFAULT_PROFILE_PATH} ${PROFILE_PATH} || true
         cp ${PROFILE_PATH} ${DEFAULT_PROFILE_PATH}
         conan remote add tket-libs https://quantinuumsw.jfrog.io/artifactory/api/conan/tket1-libs --index 0
@@ -138,12 +138,13 @@ jobs:
         cd pytket
         # Ensure wheels are compatible with MacOS 12.0 and later:
         export WHEEL_PLAT_NAME=macosx_12_0_arm64
-        python${{ matrix.python-version }} -m pip install -U pip build delocate
+        python${{ matrix.python-version }} -m pip install -U pip build
+        python${{ matrix.python-version }} -m pip install delocate~=0.10.7
         python${{ matrix.python-version }} -m build
         delocate-wheel -v -w "$GITHUB_WORKSPACE/wheelhouse/" "dist/pytket-"*".whl"
     - uses: actions/upload-artifact@v4
       with:
-        name: MacOS_M1_${{ matrix.python-version }}_wheel
+        name: MacOS_arm64_${{ matrix.python-version }}_wheel
         path: wheelhouse/
 
   build_Windows_wheels:
@@ -252,9 +253,9 @@ jobs:
     - name: Run tests
       run: cd tket/pytket/tests && pytest --ignore=simulator/
 
-  test_macos_wheels:
-    name: Test macos wheels
-    needs: build_macos_wheels
+  test_macos_x86_wheels:
+    name: Test macos x86 wheels
+    needs: build_macos_x86_wheels
     strategy:
       matrix:
         os: ['macos-12', 'macos-13']
@@ -268,7 +269,7 @@ jobs:
     - name: Download wheels
       uses: actions/download-artifact@v4
       with:
-        name: MacOS_${{ matrix.python-version }}_wheel
+        name: MacOS_x86_${{ matrix.python-version }}_wheel
         path: wheelhouse/
     - uses: actions/checkout@v4
       with:
@@ -282,13 +283,14 @@ jobs:
         pip install -r requirements.txt
         pytest --ignore=simulator/
 
-  test_macos_M1_wheels:
-    name: Test macos (M1) wheels
-    needs: build_macos_M1_wheels
-    runs-on: macos-13-xlarge
+  test_macos_arm64_wheels:
+    name: Test macos arm64 wheels
+    needs: build_macos_arm64_wheels
     strategy:
       matrix:
+        os: ['macos-13-xlarge', 'macos-14']
         python-version: ['3.10', '3.11', '3.12']
+    runs-on: ${{ matrix.os }}
     steps:
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
@@ -297,7 +299,7 @@ jobs:
     - name: Download wheels
       uses: actions/download-artifact@v4
       with:
-        name: MacOS_M1_${{ matrix.python-version }}_wheel
+        name: MacOS_arm64_${{ matrix.python-version }}_wheel
         path: wheelhouse/
     - uses: actions/checkout@v4
       with:
@@ -344,7 +346,7 @@ jobs:
   publish_to_pypi:
     name: Publish to pypi
     if: github.event_name == 'release'
-    needs: [test_linux_wheels, test_linux_aarch64_wheels, test_macos_wheels, test_macos_M1_wheels, test_Windows_wheels]
+    needs: [test_linux_wheels, test_linux_aarch64_wheels, test_macos_x86_wheels, test_macos_arm64_wheels, test_Windows_wheels]
     runs-on: ubuntu-22.04
     steps:
     - name: Download all wheels

.github/workflows/test_libs.yml

@@ -63,7 +63,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: ['ubuntu-22.04', 'macos-12', 'windows-2022', 'macos-13-xlarge']
+        os: ['ubuntu-22.04', 'macos-12', 'windows-2022', 'macos-14']
         lib: ${{ fromJson(needs.set_libs_matrix.outputs.libs) }}
     runs-on: ${{ matrix.os }}
     steps:

.github/workflows/test_libs_all.yml

@@ -10,7 +10,7 @@ jobs:
     name: test library
     strategy:
       matrix:
-        os: ['ubuntu-22.04', 'macos-12', 'windows-2022', 'macos-13-xlarge']
+        os: ['ubuntu-22.04', 'macos-12', 'windows-2022', 'macos-14']
         lib: ['tklog', 'tkassert', 'tkrng', 'tktokenswap', 'tkwsm']
     runs-on: ${{ matrix.os }}
     steps:

.gitignore

@@ -35,3 +35,5 @@ pytket/tests/qasm_test_files/testout6.qasm
 
 #nix
 result
+.envrc
+.direnv/

README.md

@@ -153,3 +153,13 @@ building and testing pytket.
 Tket and pytket are available as a Nix flake, with support for Linux and Apple Silicon systems.
 See the [README](nix-support/README.md) in the `nix-support` directory for instructions
 on building and testing tket and pytket through Nix, and on how to use it within a Nix project.
+
+To launch into a tket environment, you can use
+
+```
+nix develop github:CQCL/tket
+```
+
+We use Cachix to cache pre-built artifacts, which provides a faster install time for nix users.
+To make use of this cache, enable our cachix substituter with `cachix use tket`, or enter a
+tket nix environment from a trusted user and confirm the use of the tket.cachix.org substituter.

build-without-conan.md

@@ -91,9 +91,9 @@ cmake --install .
 
 ```
 cd ${TMP_DIR}
-wget https://github.com/catchorg/Catch2/archive/refs/tags/v3.5.2.tar.gz
-tar xzvf v3.5.2.tar.gz
-cd Catch2-3.5.2/
+wget https://github.com/catchorg/Catch2/archive/refs/tags/v3.5.4.tar.gz
+tar xzvf v3.5.4.tar.gz
+cd Catch2-3.5.4/
 mkdir build
 cd build
 cmake -DCMAKE_INSTALL_PREFIX=${INSTALL_DIR} ..
@@ -119,9 +119,9 @@ cmake --install .
 
 ```
 cd ${TMP_DIR}
-wget https://github.com/pybind/pybind11/archive/refs/tags/v2.11.1.tar.gz
-tar xzvf v2.11.1.tar.gz
-cd pybind11-2.11.1/
+wget https://github.com/pybind/pybind11/archive/refs/tags/v2.12.0.tar.gz
+tar xzvf v2.12.0.tar.gz
+cd pybind11-2.12.0/
 mkdir build
 cd build
 cmake -DCMAKE_INSTALL_PREFIX=${INSTALL_DIR} -DPYBIND11_TEST=OFF ..

conan-profiles/macos-13-xlarge → conan-profiles/macos-14

@@ -4,5 +4,5 @@ build_type=Release
 compiler=apple-clang
 compiler.cppstd=gnu17
 compiler.libcxx=libc++
-compiler.version=14
+compiler.version=15
 os=Macos

flake.nix

@@ -1,5 +1,10 @@
 {
   description = "Tket Quantum SDK";
+  nixConfig.extra-substituters = "https://tket.cachix.org https://cache.nixos.org";
+  nixConfig.trusted-public-keys = ''
+    tket.cachix.org-1:ACdm5Zg19qPL0PpvUwTPPiIx8SEUy+D/uqa9vKJFwh0=
+    cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=
+  '';
   inputs.nixpkgs.url = "github:nixos/nixpkgs";
   inputs.flake-utils.url = "github:numtide/flake-utils";
   outputs = { self, nixpkgs, flake-utils }:

libs/tkassert/test/conanfile.py

@@ -60,4 +60,4 @@ def package(self):
 
     def requirements(self):
         self.requires("tkassert/0.3.4")
-        self.requires("catch2/3.5.2")
+        self.requires("catch2/3.5.4")

libs/tklog/test/conanfile.py

@@ -60,4 +60,4 @@ def package(self):
 
     def requirements(self):
         self.requires("tklog/0.3.3")
-        self.requires("catch2/3.5.2")
+        self.requires("catch2/3.5.4")

libs/tkrng/test/conanfile.py

@@ -60,4 +60,4 @@ def package(self):
 
     def requirements(self):
         self.requires("tkrng/0.3.3")
-        self.requires("catch2/3.5.2")
+        self.requires("catch2/3.5.4")

libs/tktokenswap/test/conanfile.py

@@ -61,4 +61,4 @@ def package(self):
     def requirements(self):
         self.requires("tktokenswap/0.3.7")
         self.requires("tkrng/0.3.3@tket/stable")
-        self.requires("catch2/3.5.2")
+        self.requires("catch2/3.5.4")

libs/tkwsm/test/conanfile.py

@@ -62,4 +62,4 @@ def requirements(self):
         self.requires("tkwsm/0.3.7")
         self.requires("tkassert/0.3.4@tket/stable")
         self.requires("tkrng/0.3.3@tket/stable")
-        self.requires("catch2/3.5.2")
+        self.requires("catch2/3.5.4")