Merge branch 'dev' into feat/refactor-n-memory

Author: ciaranra

.gitignore

@@ -1,9 +1,6 @@
 tmp/
 **/.*/settings.local.json
 
-# Ignore helper text in root
-*.txt
-
 # pytest results
 junit/
 

.pre-commit-config.yaml

@@ -19,19 +19,19 @@ repos:
       - id: debug-statements
 
   - repo: https://github.com/crate-ci/typos
-    rev: v1.28.3
+    rev: v1
     hooks:
       - id: typos
         args: []
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.8.3
+    rev: v0.11.11
     hooks:
-      - id: ruff
+      - id: ruff-check
         args: [--fix, --exit-non-zero-on-fix]
 
   - repo: https://github.com/psf/black
-    rev: 24.10.0
+    rev: 25.1.0
     hooks:
       - id: black
 

.python-version

@@ -0,0 +1 @@
+3.13

README.md

@@ -122,9 +122,6 @@ If you are interested in editing or developing the code in this project, see thi
 
 Certain simulators from `pecos.simulators` require external packages that are not installed by `pip install .[all]`.
 
-- `QuEST` is installed along with the python package `pyquest` when calling `pip install .[all]`. However, it uses
-64-bit float point precision by default, and if you wish to make use of 32-bit float point precision you will need to
-follow the installation instructions provided by the developers [here](https://github.com/rrmeister/pyQuEST/tree/develop).
 - `CuStateVec` requires a Linux machine with an NVIDIA GPU (see requirements [here](https://docs.nvidia.com/cuda/cuquantum/latest/getting_started/getting_started.html#dependencies-custatevec-label)). PECOS' dependencies are
 specified in the `[cuda]` section of `pyproject.toml`, however, installation via `pip` is not reliable. The recommended method of installation is via `conda`, as discussed [here](https://docs.nvidia.com/cuda/cuquantum/latest/getting_started/getting_started.html#installing-cuquantum). Note that there might be conflicts between `conda` and `venv`; if you intend to use `CuStateVec`, you may follow the installation instructions for PECOS within a `conda` environment without involving the `venv` commands.
 - `MPS` uses `pytket-cutensornet` (see [repository](https://github.com/CQCL/pytket-cutensornet)) and can be installed via `pip install .[cuda]`. These

crates/pecos-qir/src/platform/windows_stub_gen.rs

@@ -16,7 +16,7 @@ impl ExportedFunction {
         } else {
             self.params
                 .iter()
-                .map(|(typ, name)| format!("{typ} {name}"))
+                .map(|(param_type, name)| format!("{param_type} {name}"))
                 .collect::<Vec<_>>()
                 .join(", ")
         };

docs/requirements.txt

@@ -0,0 +1,6 @@
+mkdocs>=1.5.3
+mkdocs-material>=9.4.7
+mkdocstrings>=0.24.0
+mkdocstrings-python>=1.7.4
+markdown-exec>=1.10.3
+pymdown-extensions>=10.4

examples/python_examples/logical_steane_code_program.py

@@ -9,6 +9,13 @@
 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 # specific language governing permissions and limitations under the License.
 
+"""Example demonstrating logical teleportation using Steane quantum error correction code.
+
+This module provides an example implementation of logical teleportation using the
+7-qubit Steane quantum error correction code, showcasing fault-tolerant quantum
+computation with error correction circuits.
+"""
+
 from pecos.qeclib.steane.steane_class import Steane
 from pecos.slr import Barrier, CReg, If, Main
 
@@ -27,8 +34,8 @@ def telep(prep_basis: str, meas_basis: str) -> str:
             include: "X", "Y", and "Z".
 
     Returns:
-        A logical program written in extended OpenQASM 2.0"""
-
+        A logical program written in extended OpenQASM 2.0
+    """
     prog = Main(
         m_bell := CReg("m_bell", size=2),
         m_out := CReg("m_out", size=1),
@@ -82,8 +89,8 @@ def t_gate(prep_basis: str, meas_basis: str) -> str:
             include: "X", "Y", and "Z".
 
     Returns:
-        A logical program written in extended OpenQASM 2.0"""
-
+        A logical program written in extended OpenQASM 2.0
+    """
     prog = Main(
         m_reject := CReg("m_reject", size=2),
         m_t := CReg("m_t", 1),

python/docs/conf.py

@@ -1,4 +1,12 @@
-#  =========================================================================  #  # noqa: INP001
+"""Sphinx documentation configuration for PECOS quantum error correction framework.
+
+This module configures Sphinx for generating the PECOS documentation, including
+API reference, user guides, and examples for the quantum error correction library.
+"""
+
+# ruff: noqa: INP001
+
+#  =========================================================================  #
 #   Copyright 2023 The PECOS Developers
 #   Copyright 2018 National Technology & Engineering Solutions of Sandia,
 #   LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS,
@@ -33,7 +41,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "PECOS"
-copyright = (
+copyright = (  # noqa: A001
     "2018-2023, The PECOS Developers. "
     "\xa9 Copyright 2018, National Technology & Engineering Solutions of Sandia, LLC (NTESS)"
 )

python/docs/reference/_autosummary/pecos.simulators.rst

@@ -36,7 +36,6 @@
    pecos.simulators.paulifaultprop
    pecos.simulators.projectq
    pecos.simulators.quantum_simulator
-   pecos.simulators.quest
    pecos.simulators.qulacs
    pecos.simulators.sim_class_types
    pecos.simulators.sparsesim

python/pecos-rslib/examples/bell_state_example.py

@@ -22,7 +22,7 @@
 from pecos_rslib import ByteMessage
 
 
-def bell_state_example():
+def bell_state_example() -> None:
     """Demonstrate how to create a Bell state experiment using ByteMessage."""
     print("==== Bell State Experiment Example ====")
 
@@ -64,7 +64,7 @@ def bell_state_example():
     return message
 
 
-def build_custom_message():
+def build_custom_message() -> None:
     """Build a custom quantum circuit using ByteMessage."""
     print("\n==== Custom Circuit Example ====")