Merge branch 'main' into LightSABRE-CustomPass

.github/workflows/build_and_test.yml

@@ -25,7 +25,7 @@ jobs:
     name: Qiskit - Build and test module
     strategy:
       matrix:
-        os: ['ubuntu-24.04', 'macos-14', 'windows-2022']
+        os: ['ubuntu-latest', 'macos-14', 'windows-latest']
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v4
@@ -48,7 +48,7 @@ jobs:
       with:
         python-version: '3.11'
     - name: Build and test including remote checks (3.11) mypy
-      if:  (matrix.os == 'ubuntu-24.04') && (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' )
+      if:  (matrix.os == 'ubuntu-latest') && (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
@@ -77,12 +77,12 @@ jobs:
     - name: Install poetry
       run: pip install poetry
     - name: Install docs dependencies
-      if:  (matrix.os == 'ubuntu-24.04') && (github.event_name == 'pull_request' || github.event_name == 'schedule' )
+      if:  (matrix.os == 'ubuntu-latest') && (github.event_name == 'pull_request' || github.event_name == 'schedule' )
       run: |
         cd docs && bash ./install.sh
-        for w in `find wheelhouse/ -type f -name "*.whl"` ; do poetry install $w ; done
+        for w in `find wheelhouse/ -type f -name "*.whl"` ; do poetry run pip install $w ; done
     - name: Build docs
-      if:  (matrix.os == 'ubuntu-24.04') && (github.event_name == 'pull_request' || github.event_name == 'schedule' )
+      if:  (matrix.os == 'ubuntu-latest') && (github.event_name == 'pull_request' || github.event_name == 'schedule' )
       timeout-minutes: 20
       run: |
         cd docs && poetry run bash ./build-docs.sh
@@ -92,7 +92,7 @@ jobs:
     name: Publish to pypi
     if: github.event_name == 'release'
     needs: qiskit-checks
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-latest
     steps:
     - name: Download all wheels
       # downloading all three files into the wheelhouse
@@ -117,7 +117,7 @@ jobs:
     name: Build docs
     if: github.event_name == 'release'
     needs: publish_to_pypi
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
       with:

.github/workflows/docs.yml

@@ -11,7 +11,7 @@ on:
 jobs:
   docs:
     name: build docs
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
       with: 

.github/workflows/lint.yml

@@ -8,7 +8,7 @@ on:
 jobs:
   lint:
 
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v4
@@ -19,8 +19,12 @@ jobs:
     - name: Update pip
       run: pip install --upgrade pip
     - name: Install black and pylint
-      run: pip install black pylint
+      run: pip install black pylint ruff
     - name: Check files are formatted with black
-      run: black --check .
+      run: |
+        black --check .
+    - name: Run ruff
+      run: |
+        ruff check .
     - name: Run pylint
       run: pylint */

.gitignore

@@ -15,3 +15,5 @@ pytket/extensions/qiskit/_metadata.py
 *.ipynb
 docs/pyproject.toml
 docs/poetry.lock
+.jupyter_cache/
+jupyter_execute/

.pylintrc

@@ -47,7 +47,6 @@ enable=
     unused-variable,
     unused-wildcard-import,
     wildcard-import,
-    wrong-import-order,
     wrong-import-position,
     yield-outside-function
 

README.md

@@ -3,15 +3,15 @@
 [![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)](https://tketusers.slack.com/join/shared_invite/zt-18qmsamj9-UqQFVdkRzxnXCcKtcarLRA#)
 [![Stack Exchange](https://img.shields.io/badge/StackExchange-%23ffffff.svg?style=for-the-badge&logo=StackExchange)](https://quantumcomputing.stackexchange.com/tags/pytket)
 
-[Pytket](https://tket.quantinuum.com/api-docs/index.html) is a python module for interfacing
+[Pytket](https://docs.quantinuum.com/tket/api-docs/index.html) is a python module for interfacing
 with tket, a quantum computing toolkit and optimising compiler developed by Quantinuum.
 
 `pytket-qiskit` is an extension to `pytket` that allows `pytket` circuits to be
 run on IBM backends and simulators, as well as conversion to and from Qiskit
 representations.
 
 Some useful links:
-- [API Documentation](https://tket.quantinuum.com/extensions/pytket-qiskit/)
+- [API Documentation](https://docs.quantinuum.com/tket/extensions/pytket-qiskit/)
 
 ## Getting started
 

docs/api.rst → docs/api.md

@@ -1,55 +1,78 @@
-API documentation
-~~~~~~~~~~~~~~~~~
+# API documentation
 
+```{eval-rst}
 .. autoclass:: pytket.extensions.qiskit.IBMQBackend
     :special-members: __init__
     :show-inheritance:
     :members:
+```
 
+```{eval-rst}
 .. autoclass:: pytket.extensions.qiskit.IBMQEmulatorBackend
     :special-members: __init__
     :show-inheritance:
     :members:
+```
 
+```{eval-rst}
 .. autoclass:: pytket.extensions.qiskit.AerBackend
     :special-members: __init__
     :inherited-members:
     :members:
+```
 
+```{eval-rst}
 .. autoclass:: pytket.extensions.qiskit.AerStateBackend
     :special-members: __init__
     :inherited-members:
     :members:
+```
 
+```{eval-rst}
 .. autoclass:: pytket.extensions.qiskit.AerUnitaryBackend
     :special-members: __init__
     :inherited-members:
     :members:
+```
 
+```{eval-rst}
 .. autoclass:: pytket.extensions.qiskit.AerDensityMatrixBackend
     :special-members: __init__
     :inherited-members:
     :members:
+```
 
+```{eval-rst}
 .. automodule:: pytket.extensions.qiskit
     :members: qiskit_to_tk, tk_to_qiskit, process_characterisation
+```
 
+```{eval-rst}
 .. automodule:: pytket.extensions.qiskit.tket_backend
     :show-inheritance:
     :members:
     :special-members: __init__
+```
 
+```{eval-rst}
 .. automodule:: pytket.extensions.qiskit.backends.crosstalk_model
     :members: CrosstalkParams
 
+```
 
+```{eval-rst}
 .. automodule:: pytket.extensions.qiskit.tket_pass
     :special-members: __init__
     :members:
+```
 
+```{eval-rst}
 .. automodule:: pytket.extensions.qiskit.tket_job
     :special-members: __init__
     :members:
+```
 
+```{eval-rst}
 .. automodule:: pytket.extensions.qiskit.backends.config
     :members:
+```