Release/1.26.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].4

_metadata.py

@@ -1,2 +1,2 @@
-__extension_version__ = "0.5.4"
+__extension_version__ = "0.5.5"
 __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,11 @@
 Changelog
 ~~~~~~~~~
 
+0.5.5 (March 2024)
+-------------------
+
+* 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/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:

lint-requirements.txt

@@ -1,2 +1,2 @@
-black~=23.12
-pylint~=3.0
+black~=24.2
+pylint~=3.1