Merge pull request #51 from CQCL/release/0.6.0

Release/0.6.0

.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
@@ -35,7 +36,6 @@ jobs:
         fetch-depth: '0'
     - 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 == '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'
@@ -46,7 +46,7 @@ jobs:
       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_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
@@ -98,8 +98,8 @@ jobs:
         password: ${{ secrets.PYPI_PYTKET_IQM_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
@@ -117,7 +117,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: |
@@ -127,20 +127,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 "[email protected]"
-        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/docs.yml

@@ -16,7 +16,7 @@ jobs:
     - name: Set up Python 3.9
       uses: actions/setup-python@v4
       with:
-        python-version: 3.9
+        python-version: '3.9'
     - name: Upgrade pip and install wheel
       run: pip install --upgrade pip wheel
     - name: Install pytket iqm

.github/workflows/docs/conf.py

@@ -10,9 +10,24 @@
     "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
     "sphinx.ext.mathjax",
+    "sphinx_copybutton",
 ]
 
-html_theme = "sphinx_rtd_theme"
+pygments_style = "borland"
+
+html_theme = "sphinx_book_theme"
+
+html_theme_options = {
+    "repository_url": "https://github.com/CQCL/pytket-iqm",
+    "use_repository_button": True,
+    "use_issues_button": True,
+}
+
+html_static_path = ["_static"]
+
+html_css_files = ["custom.css"]
+
+html_logo = "Quantinuum_logo.png"
 
 # -- Extension configuration -------------------------------------------------
 
@@ -29,13 +44,14 @@
 
 # The following code is for resolving broken hyperlinks in the doc.
 
-from sphinx.application import Sphinx
+import re
+from typing import Any, Dict, List, Optional
+from urllib.parse import urljoin
+
 from docutils import nodes
 from docutils.nodes import Element, TextElement
+from sphinx.application import Sphinx
 from sphinx.environment import BuildEnvironment
-from urllib.parse import urljoin
-import re
-from typing import Any, Dict, List, Optional
 
 # Mappings for broken hyperlinks that intersphinx cannot resolve
 external_url_mapping = {

.github/workflows/docs/requirements.txt

@@ -1,2 +1,3 @@
 sphinx ~= 4.3.2
-sphinx_rtd_theme
+sphinx_book_theme
+sphinx-copybutton

.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.1
       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.1
       if: contains(github.event.issue.labels.*.name, 'bug')
       with:
         project: TKET
         issuetype: Bug
         summary: « [pytket-iqm] ${{ 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.1
       if: "! contains(github.event.issue.labels.*.name, 'bug')"
       with:
         project: TKET

.gitignore

@@ -4,6 +4,7 @@ build
 dist
 *.pyc
 .vscode
+.venv
 .mypy_cache
 .hypothesis
 obj

.pylintrc

@@ -22,15 +22,13 @@ enable=
     line-too-long,
     lost-exception,
     missing-kwoa,
-    mixed-indentation,
     mixed-line-endings,
     not-callable,
     no-value-for-parameter,
     nonexistent-operator,
     not-in-loop,
     pointless-statement,
     redefined-builtin,
-    relative-import,
     return-arg-in-generator,
     return-in-init,
     return-outside-function,

README.md

@@ -33,10 +33,10 @@ from pytket.extensions.iqm import IQMBackend
 from pytket.circuit import Circuit
 
 backend = IQMBackend(
-	url="https://cortex-demo.qc.iqm.fi",
-	auth_server_url="https://auth.demo.qc.iqm.fi",
+	url="https://demo.qc.iqm.fi/cocos",
+	auth_server_url="https://demo.qc.iqm.fi/auth",
 	username="USERNAME",
-    password="PASSWORD",
+	password="PASSWORD",
 )
 
 circuit = Circuit(3, 3)
@@ -63,6 +63,10 @@ by providing the `arch` parameter to the `IQMBackend` constructor, but it genera
 does not make sense, since the IQM server reports the valid quantum architecture
 relevant to the given backend URL.
 
+(Note: At the moment IQM does not provide a quantum computing service open to the 
+general public. Please contact our [sales team](https://www.meetiqm.com/contact/) 
+to set up your access to an IQM quantum computer.)
+
 ## Bugs and feature requests
 
 Please file bugs and feature requests on the GitHub
@@ -122,7 +126,7 @@ skipped. To enable them, set the following environment variables:
 
 ```shell
 export PYTKET_RUN_REMOTE_TESTS=1
-export PYTKET_REMOTE_IQM_AUTH_SERVER_URL=https://auth.demo.qc.iqm.fi
+export PYTKET_REMOTE_IQM_AUTH_SERVER_URL=https://demo.qc.iqm.fi/auth
 export PYTKET_REMOTE_IQM_USERNAME=YOUR_USERNAME
 export PYTKET_REMOTE_IQM_PASSWORD=YOUR_PASSWORD
 ```

_metadata.py

@@ -1,2 +1,2 @@
-__extension_version__ = "0.5.0"
+__extension_version__ = "0.6.0"
 __extension_name__ = "pytket-iqm"

docs/_static/custom.css

@@ -0,0 +1,44 @@
+.wy-side-nav-search,
+.wy-nav-top {
+    background: #5A46BE;
+}
+
+.wy-grid-for-nav,
+.wy-body-for-nav,
+.wy-nav-side,
+.wy-side-scroll,
+.wy-menu,
+.wy-menu-vertical {
+    background-color: #FFFFFF;
+}
+
+.wy-menu-vertical a:hover {
+    background-color: #d9d9d9;
+}
+
+.caption-text {
+    color: #000000;
+}
+
+.btn-link:visited,
+.btn-link,
+a:visited,
+.a.reference.external,
+.a.reference.internal,
+.wy-menu-vertical a,
+.wy-menu-vertical li,
+.wy-menu-vertical ul,
+.span.pre,
+.sig-param,
+.std.std-ref,
+a {
+    color: #544d4d;
+}
+
+:root {
+    --pst-color-inline-code: 199, 37, 78 !important;
+}
+
+.sig-name {
+    font-size: 1.25rem;
+}

docs/changelog.rst

@@ -1,6 +1,14 @@
 Changelog
 ~~~~~~~~~
 
+0.6.0 (March 2023)
+------------------
+
+* Updated pytket version requirement to 1.13.
+* Updated iqm-client version requirement to 11.8.
+* New method ``IQMBackend.get_metadata()`` for reteieving metadata associated
+  with a ``ResultHandle``.
+
 0.5.0 (November 2022)
 ---------------------
 

pytket/extensions/iqm/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2020-2022 Cambridge Quantum Computing
+# Copyright 2020-2023 Cambridge Quantum Computing
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

pytket/extensions/iqm/backends/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2020-2022 Cambridge Quantum Computing
+# Copyright 2020-2023 Cambridge Quantum Computing
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

pytket/extensions/iqm/backends/config.py

@@ -1,4 +1,4 @@
-# Copyright 2020-2022 Cambridge Quantum Computing
+# Copyright 2020-2023 Cambridge Quantum Computing
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.