Merge pull request #31 from CQCL/release/1.9.0

Release/1.9.0

Author: cqc-melf

.github/workflows/build-test

@@ -51,6 +51,9 @@ cd ${GITHUB_WORKSPACE}/tests
 
 python -m pip install --pre -r test-requirements.txt
 
+# update the pytket version to the lastest (pre) release
+python -m pip install --upgrade --pre pytket~=1.0
+
 pytest --doctest-modules
 
 cd ..

.github/workflows/build_and_test.yml

@@ -9,6 +9,7 @@ on:
     branches:
       - develop
       - 'wheel/**'
+      - 'runci/**'
   release:
     types:
       - created
@@ -43,19 +44,18 @@ jobs:
       run: |
         ./.github/workflows/build-test nomypy
     - name: Set up Python 3.9
-      if: github.event_name == 'pull_request' || github.event_name == 'release' || contains(github.ref, 'refs/heads/wheel') || github.event_name == 'schedule'
       uses: actions/setup-python@v4
       with:
         python-version: '3.9'
     - name: Build and test including remote checks (3.9) mypy
-      if:  (matrix.os == 'macos-12') && ((github.event_name == 'pull_request' &&  github.event.pull_request.head.repo.full_name == github.repository) || github.event_name == 'release' || contains(github.ref, 'refs/heads/wheel') || github.event_name == 'schedule' )
+      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' )
       shell: bash
       run: |
         ./.github/workflows/build-test mypy
       env:
         PYTKET_RUN_REMOTE_TESTS: 1
     - name: Build and test including remote checks (3.9) nomypy
-      if:  (matrix.os != 'macos-12') && ((github.event_name == 'pull_request' &&  github.event.pull_request.head.repo.full_name == github.repository) || github.event_name == 'release' || contains(github.ref, 'refs/heads/wheel') || github.event_name == 'schedule' )
+      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')
       shell: bash
       run: |
         ./.github/workflows/build-test nomypy
@@ -108,8 +108,8 @@ jobs:
         password: ${{ secrets.PYPI_PYTKET_QISKIT_API_TOKEN }}
         verbose: true
 
-  docs:
-    name: Build and publish docs
+  build_docs:
+    name: Build docs
     if: github.event_name == 'release'
     needs: publish_to_pypi
     runs-on: ubuntu-22.04
@@ -127,7 +127,7 @@ jobs:
         path: wheelhouse
     - name: Install pip, wheel
       run: pip install -U pip wheel
-    - name: Install extensions
+    - name: Install extension
       run: for w in `find wheelhouse/ -type f -name "*.whl"` ; do pip install $w ; done
     - name: Install docs dependencies
       run: |
@@ -137,20 +137,24 @@ jobs:
       run: |
         cd .github/workflows/docs
         mkdir extensions
-        ./build-docs -d ${GITHUB_WORKSPACE}/.github/workflows/docs/extensions
-    - name: Configure git
-      run: |
-        git config --global user.email "tket-bot@cambridgequantum.com"
-        git config --global user.name  "«$GITHUB_WORKFLOW» github action"
-    - name: Check out gh-pages branch
-      run: git checkout gh-pages
-    - name: Remove old docs
-      run: git rm -r --ignore-unmatch docs/api
-    - name: Add generated docs to repository
-      run: |
-        mkdir -p docs
-        mv .github/workflows/docs/extensions docs/api
-        git add -f docs/api
-        git commit --allow-empty -m "Add generated documentation."
-    - name: Publish docs
-      run:  git push origin gh-pages:gh-pages
+        ./build-docs -d ${GITHUB_WORKSPACE}/.github/workflows/docs/extensions/api
+    - name: Upload docs as artefact
+      uses: actions/upload-pages-artifact@v1
+      with:
+        path: .github/workflows/docs/extensions
+
+  publish_docs:
+    name: Publish docs
+    if: github.event_name == 'release'
+    needs: build_docs
+    runs-on: ubuntu-22.04
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v1

.github/workflows/issue.yml

@@ -10,21 +10,21 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
     - name: Login
-      uses: atlassian/gajira-login@v2.0.0
+      uses: atlassian/gajira-login@v3.0.0
       env:
         JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
         JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
         JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}
     - name: Create Bug
-      uses: atlassian/gajira-create@v2.0.1
+      uses: atlassian/gajira-create@v3.0.0
       if: contains(github.event.issue.labels.*.name, 'bug')
       with:
         project: TKET
         issuetype: Bug
         summary: « [pytket-qiskit] ${{ github.event.issue.title }}»
         description: ${{ github.event.issue.html_url }}
     - name: Create Task
-      uses: atlassian/gajira-create@v2.0.1
+      uses: atlassian/gajira-create@v3.0.0
       if: "! contains(github.event.issue.labels.*.name, 'bug')"
       with:
         project: TKET

_metadata.py

@@ -1,2 +1,2 @@
-__extension_version__ = "0.30.0"
+__extension_version__ = "0.31.0"
 __extension_name__ = "pytket-qiskit"

docs/changelog.rst

@@ -1,6 +1,15 @@
 Changelog
 ~~~~~~~~~
 
+0.31.0 (November 2022)
+----------------------
+
+* Update ``TketBackend`` to support ``FullyConnected`` architecture.
+* Fix the issue that some qiskit methods can't retrieve results from ``TketJob``.
+* Updated pytket version requirement to 1.9.
+* Handle ``OpType.Phase`` when converting to qiskit.
+* Change default optimization level in ``default_compilation_pass()`` to 2.
+
 0.30.0 (November 2022)
 ----------------------
 

docs/intro.txt

@@ -101,8 +101,8 @@ Every ``Backend`` in pytket has its own ``default_compilation_pass`` method. Thi
    :header-rows: 1
 
    * - optimisation_level = 0
-     - optimisation_level = 1 [1]
-     - optimisation_level = 2
+     - optimisation_level = 1
+     - optimisation_level = 2 [1]
    * - `DecomposeBoxes <https://cqcl.github.io/tket/pytket/api/passes.html#pytket.passes.DecomposeBoxes>`_
      - `DecomposeBoxes <https://cqcl.github.io/tket/pytket/api/passes.html#pytket.passes.DecomposeBoxes>`_
      - `DecomposeBoxes <https://cqcl.github.io/tket/pytket/api/passes.html#pytket.passes.DecomposeBoxes>`_
@@ -134,7 +134,7 @@ Every ``Backend`` in pytket has its own ``default_compilation_pass`` method. Thi
      - 
      - `SimplifyInitial <https://cqcl.github.io/tket/pytket/api/passes.html#pytket.passes.SimplifyInitial>`_ [4]
 
-* [1] If no value is specified then ``optimisation_level`` defaults to a value of 1.
+* [1] If no value is specified then ``optimisation_level`` defaults to a value of 2.
 * [2] self.rebase_pass is a rebase to the gateset supported by the backend, For IBM quantum devices that is {X, SX, Rz, CX}.
 * [3] Here ``CXMappingPass`` maps program qubits to the architecture using a `NoiseAwarePlacement <https://cqcl.github.io/tket/pytket/api/placement.html#pytket.placement.NoiseAwarePlacement>`_
 * [4] ``SimplifyInitial`` has arguments ``allow_classical=False`` and ``create_all_qubits=True``.

pytket/extensions/qiskit/backends/aer.py

@@ -317,7 +317,7 @@ def required_predicates(self) -> List[Predicate]:
             ),
         ]
 
-    def default_compilation_pass(self, optimisation_level: int = 1) -> BasePass:
+    def default_compilation_pass(self, optimisation_level: int = 2) -> BasePass:
         assert optimisation_level in range(3)
         if optimisation_level == 0:
             return SequencePass([DecomposeBoxes(), self.rebase_pass()])
@@ -442,7 +442,7 @@ def required_predicates(self) -> List[Predicate]:
             pred_list.append(ConnectivityPredicate(arch))
         return pred_list
 
-    def default_compilation_pass(self, optimisation_level: int = 1) -> BasePass:
+    def default_compilation_pass(self, optimisation_level: int = 2) -> BasePass:
         assert optimisation_level in range(3)
         passlist = [DecomposeBoxes()]
         if optimisation_level == 0:

pytket/extensions/qiskit/backends/ibm.py

@@ -319,7 +319,7 @@ def required_predicates(self) -> List[Predicate]:
             ] + predicates
         return predicates
 
-    def default_compilation_pass(self, optimisation_level: int = 1) -> BasePass:
+    def default_compilation_pass(self, optimisation_level: int = 2) -> BasePass:
         assert optimisation_level in range(3)
         passlist = [DecomposeBoxes()]
         # If you make changes to the default_compilation_pass,

pytket/extensions/qiskit/backends/ibmq_emulator.py

@@ -102,7 +102,7 @@ def rebase_pass(self) -> "BasePass":
     def required_predicates(self) -> List["Predicate"]:
         return list(self._ibmq.required_predicates)
 
-    def default_compilation_pass(self, optimisation_level: int = 1) -> "BasePass":
+    def default_compilation_pass(self, optimisation_level: int = 2) -> "BasePass":
         return self._ibmq.default_compilation_pass(optimisation_level)
 
     @property

pytket/extensions/qiskit/qiskit_convert.py

@@ -464,6 +464,9 @@ def append_tk_command_to_qiskit(
         # subsequent conditional will handle it
         return Instruction("", 0, 0, [])
     if optype == OpType.Conditional:
+        if op.op.type == OpType.Phase:
+            # conditional phase not supported
+            return InstructionSet()
         if args[0] in range_preds:
             assert op.value == 1
             condition_bits, value = range_preds[args[0]]
@@ -525,6 +528,13 @@ def append_tk_command_to_qiskit(
             qiskit_gates.UGate(params[1], params[0] - half, params[2] + half),
             qargs=qargs,
         )
+
+    if optype == OpType.Phase:
+        params = _get_params(op, symb_map)
+        assert len(params) == 1
+        qcirc.global_phase += params[0]
+        return InstructionSet()
+
     # others are direct translations
     try:
         gatetype, phase = _known_gate_rev_phase[optype]

pytket/extensions/qiskit/tket_backend.py

@@ -26,6 +26,7 @@
     GateSetPredicate,
     CompilationUnit,
 )
+from pytket.architecture import FullyConnected  # type: ignore
 
 
 def _extract_basis_gates(backend: Backend) -> List[str]:
@@ -74,6 +75,19 @@ def __init__(self, backend: Backend, comp_pass: Optional[BasePass] = None):
         :type comp_pass: Optional[BasePass], optional
         """
         arch = backend.backend_info.architecture if backend.backend_info else None
+        coupling: Optional[List[List[Any]]]
+        if isinstance(arch, FullyConnected):
+            coupling = [
+                [n1.index[0], n2.index[0]]
+                for n1 in arch.nodes
+                for n2 in arch.nodes
+                if n1 != n2
+            ]
+        else:
+            coupling = (
+                [[n.index[0], m.index[0]] for n, m in arch.coupling] if arch else None
+            )
+
         config = QasmBackendConfiguration(
             backend_name=("statevector_" if backend.supports_state else "")
             + "pytket/"
@@ -93,9 +107,7 @@ def __init__(self, backend: Backend, comp_pass: Optional[BasePass] = None):
             open_pulse=False,
             memory=backend.supports_shots,
             max_shots=10000,
-            coupling_map=[[n.index[0], m.index[0]] for n, m in arch.coupling]
-            if arch
-            else None,
+            coupling_map=coupling,
             max_experiments=10000,
         )
         super().__init__(configuration=config, provider=None)
@@ -111,9 +123,13 @@ def run(
     ) -> TketJob:
         if isinstance(run_input, QuantumCircuit):
             run_input = [run_input]
-        circ_list = [qiskit_to_tk(qc) for qc in run_input]
         n_shots = options.get("shots", None)
-        jobinfos = [JobInfo(circ.qubits, circ.bits, n_shots) for circ in circ_list]
+        circ_list = []
+        jobinfos = []
+        for qc in run_input:
+            tk_circ = qiskit_to_tk(qc)
+            circ_list.append(tk_circ)
+            jobinfos.append(JobInfo(qc.name, tk_circ.qubits, tk_circ.bits, n_shots))
         if self._comp_pass:
             final_maps = []
             compiled_list = []

pytket/extensions/qiskit/tket_job.py

@@ -30,6 +30,7 @@
 
 @dataclass
 class JobInfo:
+    circuit_name: str
     qbits: List[UnitID]
     cbits: List[UnitID]
     n_shots: Optional[int]
@@ -79,6 +80,7 @@ def result(self, **kwargs: KwargTypes) -> Result:
                         tk_result, jobinfo.cbits, jobinfo.qbits, fm
                     ),
                     "header": {
+                        "name": jobinfo.circuit_name,
                         "creg_sizes": creg_sizes,
                         "memory_slots": memory_slots,
                         "clbit_labels": clbit_labels,

pytket/extensions/qiskit/tket_pass.py

@@ -73,7 +73,7 @@ class TketAutoPass(TketPass):
         "aer_simulator_unitary": AerUnitaryBackend,
     }
 
-    def __init__(self, backend: BackendV1, optimisation_level: int = 1):
+    def __init__(self, backend: BackendV1, optimisation_level: int = 2):
         """Identifies a Qiskit backend and provides the corresponding default
         compilation pass from pytket as a
         :py:class:`qiskit.transpiler.TransformationPass`.
@@ -82,8 +82,7 @@ def __init__(self, backend: BackendV1, optimisation_level: int = 1):
         :param optimisation_level: The level of optimisation to perform during
             compilation. Level 0 just solves the device constraints without
             optimising. Level 1 additionally performs some light optimisations.
-            Level 2 adds more intensive optimisations that can increase compilation
-            time for large circuits. Defaults to 1.
+            Level 2 adds more computationally intensive optimisations. Defaults to 2.
         :type optimisation_level: int, optional
         """
         if isinstance(backend._provider, AerProvider):

setup.py

@@ -43,7 +43,7 @@
     license="Apache 2",
     packages=find_namespace_packages(include=["pytket.*"]),
     include_package_data=True,
-    install_requires=["pytket ~= 1.8", "qiskit ~= 0.39.0"],
+    install_requires=["pytket ~= 1.9", "qiskit ~= 0.39.0"],
     classifiers=[
         "Environment :: Console",
         "Programming Language :: Python :: 3.8",