Release 0.33.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

@@ -32,7 +32,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)
@@ -41,7 +41,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
@@ -56,18 +56,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

@@ -14,7 +14,7 @@ jobs:
     steps:
     - 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/lint.yml

@@ -14,7 +14,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

_metadata.py

@@ -1,2 +1,2 @@
-__extension_version__ = "0.32.0"
+__extension_version__ = "0.33.0"
 __extension_name__ = "pytket-qulacs"

docs/changelog.rst

@@ -1,6 +1,12 @@
 Changelog
 ~~~~~~~~~
 
+0.33.0 (January 2024)
+---------------------
+
+* Updated pytket version requirement to 1.23.
+* Backends now report backend_info.
+
 0.32.0 (November 2023)
 ----------------------
 

pytket/extensions/qulacs/backends/qulacs_backend.py

@@ -55,7 +55,6 @@
 from pytket.circuit import Pauli
 from pytket.passes import auto_rebase_pass
 from pytket.pauli import QubitPauliString
-from pytket.architecture import Architecture
 from pytket.utils.operators import QubitPauliOperator
 from pytket.utils.outcomearray import OutcomeArray
 from pytket.extensions.qulacs.qulacs_convert import (
@@ -122,7 +121,7 @@ def __init__(
             type(self).__name__,
             None,
             __extension_version__,
-            Architecture([]),
+            None,
             self._GATE_SET,
         )
         self._result_type = result_type
@@ -142,7 +141,7 @@ def _result_id_type(self) -> _ResultIdTuple:
 
     @property
     def backend_info(self) -> Optional["BackendInfo"]:
-        return None
+        return self._backend_info
 
     @property
     def required_predicates(self) -> List[Predicate]:
@@ -291,7 +290,7 @@ def get_operator_expectation_value(
             self._check_all_circuits([state_circuit], nomeasure_warn=False)
 
         observable = Observable(state_circuit.n_qubits)
-        for (qps, coeff) in operator._dict.items():
+        for qps, coeff in operator._dict.items():
             _items = []
             if qps != QubitPauliString():
                 for qubit, pauli in qps.map.items():

pytket/extensions/qulacs/qulacs_convert.py

@@ -17,6 +17,7 @@
 import numpy as np
 from qulacs import QuantumCircuit, gate
 from pytket.circuit import Circuit, OpType
+from pytket.passes import FlattenRegisters
 
 _ONE_QUBIT_GATES = {
     OpType.X: gate.X,
@@ -43,6 +44,10 @@ def tk_to_qulacs(
 ) -> QuantumCircuit:
     """Convert a pytket circuit to a qulacs circuit object."""
     circ = circuit.copy()
+
+    if not circ.is_simple:
+        FlattenRegisters().apply(circ)
+
     if replace_implicit_swaps:
         circ.replace_implicit_wire_swaps()
     n_qubits = circ.n_qubits

setup.py

@@ -32,7 +32,7 @@
     author_email="[email protected]",
     python_requires=">=3.9",
     project_urls={
-        "Documentation": "https://tket.quantinuum.com/extensions/pytket-qulacs/api/index.html",
+        "Documentation": "https://tket.quantinuum.com/extensions/pytket-qulacs/index.html",
         "Source": "https://github.com/CQCL/pytket-qulacs",
         "Tracker": "https://github.com/CQCL/pytket-qulacs/issues",
     },
@@ -42,7 +42,7 @@
     license="Apache 2",
     packages=find_namespace_packages(include=["pytket.*"]),
     include_package_data=True,
-    install_requires=["pytket ~= 1.22", "qulacs ~= 0.6.0"],
+    install_requires=["pytket ~= 1.23", "qulacs ~= 0.6.0"],
     classifiers=[
         "Environment :: Console",
         "Programming Language :: Python :: 3.9",

tests/test-requirements.txt

@@ -2,4 +2,4 @@ pytest
 pytest-timeout ~= 2.2.0
 hypothesis
 requests_mock
-openfermion~=1.3
+openfermion~=1.6

tests/test_qulacs_backend.py

@@ -335,6 +335,11 @@ def test_backend_with_circuit_permutation() -> None:
         assert np.allclose(sv, sv1, atol=1e-10)
 
 
+def test_backend_info() -> None:
+    for b in backends:
+        assert b.backend_info is not None
+
+
 @given(
     n_shots=strategies.integers(min_value=1, max_value=10),  # type: ignore
     n_bits=strategies.integers(min_value=0, max_value=10),