Release/v0.6.0

.github/dependabot.yml

@@ -5,7 +5,7 @@ updates:
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      interval: "daily"
+      interval: "weekly"
   - package-ecosystem: pip
     directory: "/"
     schedule:

.github/workflows/build_and_test.yml

@@ -152,4 +152,4 @@ jobs:
     steps:
     - name: Deploy to GitHub Pages
       id: deployment
-      uses: actions/[email protected].3
+      uses: actions/[email protected].5

.github/workflows/check-examples.yml

@@ -0,0 +1,52 @@
+name: check examples
+
+on:
+  pull_request:
+    branches:
+      - develop
+      - main
+  schedule:
+    # 04:00 every Saturday morning
+    - cron: '0 4 * * 6'
+
+jobs:
+
+  changes:
+    runs-on: ubuntu-22.04
+    outputs:
+      examples: ${{ steps.filter.outputs.examples }}
+    steps:
+    - uses: actions/checkout@v4
+    - uses: dorny/paths-filter@v3
+      id: filter
+      with:
+        base: ${{ github.ref }}
+        filters: |
+          examples:
+            - 'examples/**'
+            - '.github/**'
+
+  check:
+    name: check examples
+    needs: changes
+    if: github.event_name == 'schedule' || needs.changes.outputs.examples == 'true'
+    runs-on: ubuntu-22.04
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: '0'
+    - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* +refs/heads/*:refs/remotes/origin/*
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.11
+    - name: install python requirements for notebooks
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install .
+        cd examples
+        python -m pip install p2j
+    - name: test example notebooks
+      run: |
+        cd examples
+        ./check-examples

.github/workflows/lint.yml

@@ -25,10 +25,10 @@ jobs:
     - name: Update pip
       run: pip install --upgrade pip
     - name: Install black and pylint
-      run: pip install black~=22.3 pylint~=2.13,!=2.13.6
+      run: pip install black~=22.3 pylint~=3.0
     - name: Check files are formatted with black
       run: |
         black --check .
     - name: Run pylint
       run: |
-        pylint --recursive=y */
+        pylint --recursive=y --ignore=ttn_tutorial.py,mps_tutorial.py */

_metadata.py

@@ -1,2 +1,2 @@
-__extension_version__ = "0.5.4"
+__extension_version__ = "0.6.0"
 __extension_name__ = "pytket-cutensornet"

docs/api.rst

@@ -3,4 +3,4 @@ API documentation
 
 .. toctree::
     modules/fullTN.rst
-    modules/mps.rst
+    modules/structured_state.rst

docs/changelog.rst

@@ -1,6 +1,19 @@
 Changelog
 ~~~~~~~~~
 
+0.6.0 (April 2024)
+-------------------
+
+* **New feature**: Tree Tensor Network (TTN) simulator, supporting both fixed ``chi`` and ``truncation_fidelity``. Calculation of single amplitudes is supported by ``get_amplitude`` and inner products by ``vdot``. Measurement and postselection are not yet supported.
+* **New API**: both ``MPS`` and ``TTN`` share a common interface: ``StructuredState``. Import paths have changed, multiple classes have been renamed: ``ConfigMPS`` is now ``Config``, ``ContractionAlg`` is now ``SimulationAlgorithm``. Documentation has been updated accordingly.
+
+* Canonicalisation of MPS is now always applied before a two-qubit gate. We found that this tends to reduce runtime due to canonicalisation decreasing virtual bond dimension.
+* Two-qubit gates are now decomposed (SVD) before applying them to remove null singular values (e.g. in ``XXPhase`` gates).
+* Fixed a bug on copying an ``MPS`` if ``truncation_fidelity`` was set.
+* Fixed a bug on ``CuTensorNetHandle`` that would prevent it from working when the device set was different from the default one (``dev=0``) and when using ``cuTensorNet>=2.3.0``.
+* Fixed a bug on ``TensorNetwork`` due to unsupported ``Create`` operation.
+* Updated pytket version requirement to 1.26.
+
 0.5.4 (January 2024)
 --------------------
 

docs/modules/structured_state.rst

@@ -0,0 +1,61 @@
+Structured state evolution
+==========================
+
+.. automodule:: pytket.extensions.cutensornet.structured_state
+
+
+Simulation
+~~~~~~~~~~
+
+.. autofunction:: pytket.extensions.cutensornet.structured_state.simulate
+
+.. autoenum:: pytket.extensions.cutensornet.structured_state.SimulationAlgorithm()
+    :members:
+
+.. autoclass:: pytket.extensions.cutensornet.structured_state.Config()
+
+    .. automethod:: __init__
+
+.. autoclass:: pytket.extensions.cutensornet.structured_state.CuTensorNetHandle
+
+
+Classes
+~~~~~~~
+
+.. autoclass:: pytket.extensions.cutensornet.structured_state.StructuredState()
+
+    .. automethod:: __init__
+    .. automethod:: is_valid
+    .. automethod:: apply_gate
+    .. automethod:: apply_scalar
+    .. automethod:: vdot
+    .. automethod:: sample
+    .. automethod:: measure
+    .. automethod:: postselect
+    .. automethod:: expectation_value
+    .. automethod:: get_fidelity
+    .. automethod:: get_statevector
+    .. automethod:: get_amplitude
+    .. automethod:: get_qubits
+    .. automethod:: get_byte_size
+    .. automethod:: get_device_id
+    .. automethod:: update_libhandle
+    .. automethod:: copy
+
+.. autoclass:: pytket.extensions.cutensornet.structured_state.TTNxGate()
+
+    .. automethod:: __init__
+
+.. autoclass:: pytket.extensions.cutensornet.structured_state.MPSxGate()
+
+    .. automethod:: __init__
+
+.. autoclass:: pytket.extensions.cutensornet.structured_state.MPSxMPO()
+
+    .. automethod:: __init__
+
+
+Miscellaneous
+~~~~~~~~~~~~~
+
+.. autofunction:: pytket.extensions.cutensornet.structured_state.prepare_circuit_mps

examples/README.md

@@ -0,0 +1,10 @@
+# Contents
+
+Available tutorials for users:
+* `mps_tutorial.ipynb`: Use of MPS simulation and features.
+* `ttn_tutorial.ipynb`: Use of TTN simulation and features.
+* `mpi/`: Example on how to use MPS for embarrasingly parallel tasks with `mpi4py` see the `mpi` folder.
+
+Developers:
+* `check-examples`: The script to check that the Jupyter notebooks are generated correctly from the files in `python/`. To generate the `.ipynb` from these run the `p2j` command in this script.
+* `python/`: The `.py` files that generate the `.ipynb` files. As a developer, you are expected to update these files instead of the `.ipynb` files. Remember to generate the latter using the `p2j` command before opening a pull request that changes these examples.

examples/check-examples

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+set -e
+
+for name in `cat ci-tested-notebooks.txt`
+do
+    echo "Checking: ${name} ..."
+    # Check that notebook is generated from script:
+    p2j -o -t ${name}-gen.ipynb python/${name}.py
+    cmp ${name}.ipynb ${name}-gen.ipynb
+    rm ${name}-gen.ipynb
+    # TODO, add this when GPU is added to CI
+    # Run script:    
+    # python python/${name}.py
+done

examples/ci-tested-notebooks.txt

@@ -0,0 +1,2 @@
+mps_tutorial
+ttn_tutorial

examples/mpi/mpi_overlap_bcast_mps.py

@@ -42,10 +42,10 @@
 
 from pytket.circuit import Circuit, fresh_symbol
 
-from pytket.extensions.cutensornet.mps import (
+from pytket.extensions.cutensornet.structured_state import (
     simulate,
-    ConfigMPS,
-    ContractionAlg,
+    Config,
+    SimulationAlgorithm,
     CuTensorNetHandle,
 )
 
@@ -109,7 +109,7 @@
 this_proc_mps = []
 with CuTensorNetHandle(device_id) as libhandle:  # Different handle for each process
     for circ in this_proc_circs:
-        mps = simulate(libhandle, circ, ContractionAlg.MPSxGate, ConfigMPS())
+        mps = simulate(libhandle, circ, SimulationAlgorithm.MPSxGate, Config())
         this_proc_mps.append(mps)
 
 if rank == root: