qLDPC 0.2.8__tar.gz → 0.3.0__tar.gz

{qldpc-0.2.8 → qldpc-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qLDPC
-Version: 0.2.8
+Version: 0.3.0
 Summary: Tools for constructing and analyzing quantum low density parity check (qLDPC) codes.
 Keywords: quantum computing,quantum error correction,low density parity check codes,LDPC
 Author: Michael A. Perlin
@@ -21,9 +21,10 @@ Requires-Dist: platformdirs>=4.0.0
 Requires-Dist: pymatching>=2.1.0
 Requires-Dist: pyperclip>=1.11.0
 Requires-Dist: scipy>=1.14.1
-Requires-Dist: stim>=1.16.dev1768963940
+Requires-Dist: sinter>=1.16.0
+Requires-Dist: stim>=1.16.0
 Requires-Dist: sympy>=1.12
-Requires-Dist: checks-superstaq>=0.5.45 ; extra == 'dev'
+Requires-Dist: checks-superstaq>=0.5.62 ; extra == 'dev'
 Requires-Dist: jupyter>=1.1.1 ; extra == 'dev'
 Requires-Dist: python-lsp-server[all]>=1.14.0 ; extra == 'dev'
 Requires-Dist: relay-bp[stim]==0.2.1 ; extra == 'dev'
@@ -43,7 +44,8 @@ In a nutshell, `qLDPC` provides methods to build a variety of built-in and custo
 - constructing a canonical basis of logical Pauli operators,
 - computing (or upper-bounding) code distance,
 - computing logical error rates in a code-capacity model,
-- constructing various circuits of interest, such as a quantum memory experiment for obtaining circuit-level logical error rates,
+- computing the logical error rates and post-selection rates of state preparation circuits,
+- constructing circuits of interest, such as memory experiments and logical encoding circuits,
 - defining custom Pauli noise models,
 - using a decoder of your choice for any of the above (or other, unlisted) tasks.
 
@@ -67,17 +69,24 @@ You can also `pip install -e 'qLDPC[dev]'` to additionally install some developm
 
 ### GAP
 
-Some features in `qLDPC` require an installation of the [GAP](https://www.gap-system.org) computer algebra system.  If you (a) use linux or macOS, and (b) use a `conda` to manage your python environment, then you can obtain GAP by running `conda install -c conda-forge gap` (or `gap-core`).  Installations without `conda` should also work, as long as `gap` is a recognized command in the command line.  Unfortunately, [GAP](https://www.gap-system.org) integration is clunky in Windows because I have not figured out how to call [GAP](https://www.gap-system.org) from the Windows command prompt.  If you figure this out, [please let me know](https://github.com/qLDPCOrg/qLDPC/issues/294)!
+Some features in `qLDPC` require an installation of the [GAP](https://www.gap-system.org) computer algebra system.  If you (a) use linux or macOS, and (b) use a `conda` to manage your python environment, then you can obtain GAP by running
+```
+conda install -c conda-forge gap
+```
+or `conda install -c conda-forge gap-core`.  Installations without `conda` should also work, as long as `gap` is a recognized command in the command line.  Unfortunately, [GAP](https://www.gap-system.org) integration is clunky in Windows because I have not figured out how to call [GAP](https://www.gap-system.org) from the Windows command prompt.  If you figure this out, [please let me know](https://github.com/qLDPCOrg/qLDPC/issues/294)!
 
 ### macOS
 
-If you use macOS you may need to install `cvxpy` manually by following the instructions [here](https://www.cvxpy.org/install) before installing `qLDPC`.  If you use `conda` to manage your python environment, you can obtain `cvxpy` by running `conda install -c conda-forge cvxpy`.
+If you use macOS you may need to install `cvxpy` manually by following the instructions [here](https://www.cvxpy.org/install) before installing `qLDPC`.  If you use `conda` to manage your python environment, you can obtain `cvxpy` by running
+```
+conda install -c conda-forge cvxpy
+```
 
 ## 🚀 Features
 
 Notable features include:
 - `ClassicalCode`: class for representing classical linear error-correcting codes over finite fields.
-  - Various pre-defined classical code families.
+  - Various pre-defined classical code families, including `RepetitionCode`, `HammingCode`, `SimplexCode`, `ReedMullerCode`, `ReedSolomonCode`, `TannerCode`, and more.
   - Communication with the [GAP](https://www.gap-system.org)/[`GUAVA`](https://www.gap-system.org/Packages/guava.html) package for [even more codes](https://docs.gap-system.org/pkg/guava/doc/chap5.html).
 - `QuditCode`: class for constructing [Galois-qudit codes](https://errorcorrectionzoo.org/c/galois_into_galois), including both [stabilizer](https://errorcorrectionzoo.org/c/galois_stabilizer) and [subsystem](https://errorcorrectionzoo.org/c/oecc) codes.
   - `QuditCode.get_logical_ops`: method to construct a complete basis of nontrivial logical Pauli operators for a `QuditCode`.
@@ -87,8 +96,10 @@ Notable features include:
   - Common codes such as the `SteaneCode` and `TetrahedralCode`.
   - Common code families such as the `SurfaceCode`, `ToricCode`, `BaconShorCode`, and `QuantumHammingCode`.
   - `TBCode`: [two-block quantum codes](https://errorcorrectionzoo.org/c/two_block_quantum).
+  - `QCCode`: quasi-cyclic two-block codes (also known as [multivariate bicycle codes](https://arxiv.org/abs/2406.19151), generalizing the `BBCode` below).
   - `BBCode`: [bivariate bicycle codes](https://errorcorrectionzoo.org/c/quantum_quasi_cyclic), as in [arXiv:2308.07915](https://arxiv.org/abs/2308.07915) and [arXiv:2311.16980](https://arxiv.org/abs/2311.16980).  See also [`examples/bivariate_bicycle_codes.ipynb`](https://github.com/qLDPCOrg/qLDPC/blob/main/examples/bivariate_bicycle_codes.ipynb).
   - `HGPCode`: [hypergraph product codes](https://errorcorrectionzoo.org/c/hypergraph_product), first introduced in [arXiv:0903.0566](https://arxiv.org/abs/0903.0566).
+  - `CHGPCode` / `CRCode`: cyclic hypergraph product and repeated cyclic hypergraph product codes, as in [arXiv:2511.09683](https://arxiv.org/abs/2511.09683).
   - `SHPCode`: [subsystem hypergraph product codes](https://errorcorrectionzoo.org/c/subsystem_quantum_parity), as in [arXiv:2002.06257](https://arxiv.org/abs/2002.06257).
   - `SHYPSCode`: [subsystem hypergraph product simplex codes](https://errorcorrectionzoo.org/c/shyps), as in [arXiv:2502.07150](https://arxiv.org/abs/2502.07150).
   - `LPCode`: [lifted product codes](https://errorcorrectionzoo.org/c/lifted_product), as in [arXiv:2012.04068](https://arxiv.org/abs/2012.04068) and [arXiv:2202.01702](https://arxiv.org/abs/2202.01702).
@@ -97,8 +108,12 @@ Notable features include:
 - `qldpc.decoders`: module for decoding code and circuit errors.
   - BP-OSD, BP-LSD, and belief-find (via [`ldpc`](https://github.com/quantumgizmos/ldpc)), Relay-BP (via [`relay-bp`](https://pypi.org/project/relay-bp)), minimum-weight perfect matching (via [`pymatching`](https://github.com/oscarhiggott/PyMatching)), lookup-table decoding, and others.  Includes an interface for using custom decoders.
   - `SinterDecoder`: class to construct circuit-level decoders that are usable by [`sinter`](https://pypi.org/project/sinter).
+  - `SlidingWindowDecoder`: the overlapping-recovery sliding-window decoder of [arXiv:quant-ph/0110143](https://arxiv.org/abs/quant-ph/0110143) and [arXiv:2209.08552](https://arxiv.org/pdf/2209.08552).
+  - `SequentialWindowDecoder`: a generalization of the `SlidingWindowDecoder` for arbitrary decoding and commit regions.
+  - `DetectorErrorModelArrays`: representation of a `stim.DetectorErrorModel` with `scipy.sparse` and `numpy` arrays (`detector_flip_matrix`, `observable_flip_matrix`, `error_probs`).
 - `qldpc.circuits`: module for [`stim`](https://github.com/quantumlib/Stim) circuits and circuit utilities, including:
   - `get_memory_experiment`: circuit to test the performance of a code as a quantum memory (using various pre-built syndrome measurement strategies), appropriately annotated with detectors and observables.
+  - `get_state_prep_diagnostic_circuit`, `get_state_prep_diagnostic_tasks`, `get_logical_error_and_discard_rate`: helper methods for computing the logical error rates and post-selection rates of state preparation circuits.
   - `NoiseModel`: class for constructing expressive Pauli noise models, which map noiseless circuits to noisy circuits.  Built-in subclasses include a single-parameter `DepolarizingNoiseModel` and a superconducting-inspired `SI1000NoiseModel`.
   - `get_encoding_circuit`: circuit to encode physical states of qubits into logical states of a code, for example to prepare a logical all-|0> state.  (Warning: current encoding circuits are not fault-tolerant.  The construction of fault-tolerant encoding circuits is an [open issue](https://github.com/qLDPCOrg/qLDPC/issues/327).)
   - `get_transversal_ops`: logical tableaus and physical circuits for the SWAP-transversal logical Clifford gates of a code, constructed via the code automorphism method of [arXiv:2409.18175](https://arxiv.org/abs/2409.18175).  (Warning: exponential complexity.)

{qldpc-0.2.8 → qldpc-0.3.0}/README.md

@@ -7,7 +7,8 @@ In a nutshell, `qLDPC` provides methods to build a variety of built-in and custo
 - constructing a canonical basis of logical Pauli operators,
 - computing (or upper-bounding) code distance,
 - computing logical error rates in a code-capacity model,
-- constructing various circuits of interest, such as a quantum memory experiment for obtaining circuit-level logical error rates,
+- computing the logical error rates and post-selection rates of state preparation circuits,
+- constructing circuits of interest, such as memory experiments and logical encoding circuits,
 - defining custom Pauli noise models,
 - using a decoder of your choice for any of the above (or other, unlisted) tasks.
 
@@ -31,17 +32,24 @@ You can also `pip install -e 'qLDPC[dev]'` to additionally install some developm
 
 ### GAP
 
-Some features in `qLDPC` require an installation of the [GAP](https://www.gap-system.org) computer algebra system.  If you (a) use linux or macOS, and (b) use a `conda` to manage your python environment, then you can obtain GAP by running `conda install -c conda-forge gap` (or `gap-core`).  Installations without `conda` should also work, as long as `gap` is a recognized command in the command line.  Unfortunately, [GAP](https://www.gap-system.org) integration is clunky in Windows because I have not figured out how to call [GAP](https://www.gap-system.org) from the Windows command prompt.  If you figure this out, [please let me know](https://github.com/qLDPCOrg/qLDPC/issues/294)!
+Some features in `qLDPC` require an installation of the [GAP](https://www.gap-system.org) computer algebra system.  If you (a) use linux or macOS, and (b) use a `conda` to manage your python environment, then you can obtain GAP by running
+```
+conda install -c conda-forge gap
+```
+or `conda install -c conda-forge gap-core`.  Installations without `conda` should also work, as long as `gap` is a recognized command in the command line.  Unfortunately, [GAP](https://www.gap-system.org) integration is clunky in Windows because I have not figured out how to call [GAP](https://www.gap-system.org) from the Windows command prompt.  If you figure this out, [please let me know](https://github.com/qLDPCOrg/qLDPC/issues/294)!
 
 ### macOS
 
-If you use macOS you may need to install `cvxpy` manually by following the instructions [here](https://www.cvxpy.org/install) before installing `qLDPC`.  If you use `conda` to manage your python environment, you can obtain `cvxpy` by running `conda install -c conda-forge cvxpy`.
+If you use macOS you may need to install `cvxpy` manually by following the instructions [here](https://www.cvxpy.org/install) before installing `qLDPC`.  If you use `conda` to manage your python environment, you can obtain `cvxpy` by running
+```
+conda install -c conda-forge cvxpy
+```
 
 ## 🚀 Features
 
 Notable features include:
 - `ClassicalCode`: class for representing classical linear error-correcting codes over finite fields.
-  - Various pre-defined classical code families.
+  - Various pre-defined classical code families, including `RepetitionCode`, `HammingCode`, `SimplexCode`, `ReedMullerCode`, `ReedSolomonCode`, `TannerCode`, and more.
   - Communication with the [GAP](https://www.gap-system.org)/[`GUAVA`](https://www.gap-system.org/Packages/guava.html) package for [even more codes](https://docs.gap-system.org/pkg/guava/doc/chap5.html).
 - `QuditCode`: class for constructing [Galois-qudit codes](https://errorcorrectionzoo.org/c/galois_into_galois), including both [stabilizer](https://errorcorrectionzoo.org/c/galois_stabilizer) and [subsystem](https://errorcorrectionzoo.org/c/oecc) codes.
   - `QuditCode.get_logical_ops`: method to construct a complete basis of nontrivial logical Pauli operators for a `QuditCode`.
@@ -51,8 +59,10 @@ Notable features include:
   - Common codes such as the `SteaneCode` and `TetrahedralCode`.
   - Common code families such as the `SurfaceCode`, `ToricCode`, `BaconShorCode`, and `QuantumHammingCode`.
   - `TBCode`: [two-block quantum codes](https://errorcorrectionzoo.org/c/two_block_quantum).
+  - `QCCode`: quasi-cyclic two-block codes (also known as [multivariate bicycle codes](https://arxiv.org/abs/2406.19151), generalizing the `BBCode` below).
   - `BBCode`: [bivariate bicycle codes](https://errorcorrectionzoo.org/c/quantum_quasi_cyclic), as in [arXiv:2308.07915](https://arxiv.org/abs/2308.07915) and [arXiv:2311.16980](https://arxiv.org/abs/2311.16980).  See also [`examples/bivariate_bicycle_codes.ipynb`](https://github.com/qLDPCOrg/qLDPC/blob/main/examples/bivariate_bicycle_codes.ipynb).
   - `HGPCode`: [hypergraph product codes](https://errorcorrectionzoo.org/c/hypergraph_product), first introduced in [arXiv:0903.0566](https://arxiv.org/abs/0903.0566).
+  - `CHGPCode` / `CRCode`: cyclic hypergraph product and repeated cyclic hypergraph product codes, as in [arXiv:2511.09683](https://arxiv.org/abs/2511.09683).
   - `SHPCode`: [subsystem hypergraph product codes](https://errorcorrectionzoo.org/c/subsystem_quantum_parity), as in [arXiv:2002.06257](https://arxiv.org/abs/2002.06257).
   - `SHYPSCode`: [subsystem hypergraph product simplex codes](https://errorcorrectionzoo.org/c/shyps), as in [arXiv:2502.07150](https://arxiv.org/abs/2502.07150).
   - `LPCode`: [lifted product codes](https://errorcorrectionzoo.org/c/lifted_product), as in [arXiv:2012.04068](https://arxiv.org/abs/2012.04068) and [arXiv:2202.01702](https://arxiv.org/abs/2202.01702).
@@ -61,8 +71,12 @@ Notable features include:
 - `qldpc.decoders`: module for decoding code and circuit errors.
   - BP-OSD, BP-LSD, and belief-find (via [`ldpc`](https://github.com/quantumgizmos/ldpc)), Relay-BP (via [`relay-bp`](https://pypi.org/project/relay-bp)), minimum-weight perfect matching (via [`pymatching`](https://github.com/oscarhiggott/PyMatching)), lookup-table decoding, and others.  Includes an interface for using custom decoders.
   - `SinterDecoder`: class to construct circuit-level decoders that are usable by [`sinter`](https://pypi.org/project/sinter).
+  - `SlidingWindowDecoder`: the overlapping-recovery sliding-window decoder of [arXiv:quant-ph/0110143](https://arxiv.org/abs/quant-ph/0110143) and [arXiv:2209.08552](https://arxiv.org/pdf/2209.08552).
+  - `SequentialWindowDecoder`: a generalization of the `SlidingWindowDecoder` for arbitrary decoding and commit regions.
+  - `DetectorErrorModelArrays`: representation of a `stim.DetectorErrorModel` with `scipy.sparse` and `numpy` arrays (`detector_flip_matrix`, `observable_flip_matrix`, `error_probs`).
 - `qldpc.circuits`: module for [`stim`](https://github.com/quantumlib/Stim) circuits and circuit utilities, including:
   - `get_memory_experiment`: circuit to test the performance of a code as a quantum memory (using various pre-built syndrome measurement strategies), appropriately annotated with detectors and observables.
+  - `get_state_prep_diagnostic_circuit`, `get_state_prep_diagnostic_tasks`, `get_logical_error_and_discard_rate`: helper methods for computing the logical error rates and post-selection rates of state preparation circuits.
   - `NoiseModel`: class for constructing expressive Pauli noise models, which map noiseless circuits to noisy circuits.  Built-in subclasses include a single-parameter `DepolarizingNoiseModel` and a superconducting-inspired `SI1000NoiseModel`.
   - `get_encoding_circuit`: circuit to encode physical states of qubits into logical states of a code, for example to prepare a logical all-|0> state.  (Warning: current encoding circuits are not fault-tolerant.  The construction of fault-tolerant encoding circuits is an [open issue](https://github.com/qLDPCOrg/qLDPC/issues/327).)
   - `get_transversal_ops`: logical tableaus and physical circuits for the SWAP-transversal logical Clifford gates of a code, constructed via the code automorphism method of [arXiv:2409.18175](https://arxiv.org/abs/2409.18175).  (Warning: exponential complexity.)

{qldpc-0.2.8 → qldpc-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "qLDPC"
-version = "0.2.8"
+version = "0.3.0"
 description = "Tools for constructing and analyzing quantum low density parity check (qLDPC) codes."
 readme = "README.md"
 license = "Apache-2.0"
@@ -31,20 +31,19 @@ dependencies = [
   "pymatching>=2.1.0",
   "pyperclip>=1.11.0",
   "scipy>=1.14.1",
-  "stim>=1.16.dev1768963940",
+  "sinter>=1.16.0",
+  "stim>=1.16.0",
   "sympy>=1.12",
 ]
 
 [project.optional-dependencies]
 dev = [
-  "checks-superstaq>=0.5.45",
+  "checks-superstaq>=0.5.62",
   "jupyter>=1.1.1",
   "python-lsp-server[all]>=1.14.0",
   "relay-bp[stim]==0.2.1",
 ]
-relay-bp = [
-  "relay-bp[stim]==0.2.1",
-]
+relay-bp = ["relay-bp[stim]==0.2.1"]
 
 [project.urls]
 Repository = "https://github.com/qLDPCOrg/qLDPC"

qldpc-0.3.0/src/qldpc/abstract/__init__.py

@@ -0,0 +1,67 @@
+from .groups import (
+    GF2,
+    PSL,
+    SL,
+    AbelianGroup,
+    AlternatingGroup,
+    CyclicGroup,
+    DihedralGroup,
+    Group,
+    GroupMember,
+    ProjectiveSpecialLinearGroup,
+    QuaternionGroup,
+    SmallGroup,
+    SpecialLinearGroup,
+    SymmetricGroup,
+    TrivialGroup,
+    get_coefficient_and_exponents,
+    resolve_field,
+)
+from .linalg import (
+    block_diag,
+    get_howell_dual,
+    kron,
+    matmul,
+)
+from .rings import (
+    Element,
+    GroupRing,
+    Protograph,
+    RingArray,
+    RingMember,
+)
+from .wedderburn_artin import (
+    WedderburnArtinComponentTransformer,
+    WedderburnArtinTransformer,
+)
+
+__all__ = [
+    "GF2",
+    "PSL",
+    "SL",
+    "AbelianGroup",
+    "AlternatingGroup",
+    "CyclicGroup",
+    "DihedralGroup",
+    "Group",
+    "GroupMember",
+    "ProjectiveSpecialLinearGroup",
+    "QuaternionGroup",
+    "SmallGroup",
+    "SpecialLinearGroup",
+    "SymmetricGroup",
+    "TrivialGroup",
+    "get_coefficient_and_exponents",
+    "resolve_field",
+    "block_diag",
+    "get_howell_dual",
+    "kron",
+    "matmul",
+    "Element",
+    "GroupRing",
+    "Protograph",
+    "RingArray",
+    "RingMember",
+    "WedderburnArtinComponentTransformer",
+    "WedderburnArtinTransformer",
+]