qLDPC

This package contains tools for constructing and analyzing quantum low density parity check (qLDPC) codes. At least, that was the original motivation for this package. In practice, the tools here work just as well with more general error-correcting codes.

📦 Installation

This package requires Python>=3.10, and can be installed from the Python Package Index (PyPI) with

pip install qldpc

If you use macOS, you may need to install cvxpy manually by following the instructions here before installing qLDPC.

To install a local version of qLDPC from source:

git clone git@github.com:Infleqtion/qLDPC.git
pip install -e qLDPC

You can also pip install -e 'qLDPC[dev]' to additionally install some development tools.

🚀 Features

Notable features include:

  • ClassicalCode: class for representing classical linear error-correcting codes over finite fields.
  • QuditCode: general class for constructing Galois-qudit codes.
    • Automatic construction of all transversal logical Clifford gates in one code block of a qubit code with, qldpc.circuits.get_transversal_ops (see arXiv:2409.18175; requires GAP and GUAVA).
    • QuditCode.get_logical_ops: method to construct a complete basis of nontrivial logical Pauli operators for a QuditCode.
  • CSSCode: subclass of QuditCode for the special case of constructing a quantum CSS code out of two mutually compatible ClassicalCodes.
    • CSSCode.get_distance: method to compute the code distance (i.e., the minimum weight of a nontrivial logical operator) of a CSSCode. Includes options for computing the exact code distance by brute force, as well as an estimate (or upper bound) with the method of arXiv:2308.07915.
    • Includes options for applying local Hadamard transformations, which is useful for tailoring a CSSCode to biased noise (see arXiv:2202.01702).
  • TBCode: class for constructing two-block quantum codes.
  • BBCode: class for constructing the bivariate bicycle codes in arXiv:2308.07915 and arXiv:2311.16980.
    • Includes methods to identify "toric layouts" of a BBCode, in which the code looks like a toric code augmented by some long-distance checks, as in discussed in arXiv:2308.07915.
  • HGPCode: class for constructing hypergraph product codes out of two ClassicalCodes.
  • LPCode: class for constructing lifted product codes out of two protographs (i.e., matrices whose entries are elements of a group algebra). See arXiv:2012.04068 and arXiv:2202.01702.
  • QTCode: class for constructing quantum Tanner codes out of (a) two symmetric subsets A and B of a group G, and (b) two ClassicalCodes with block lengths |A| and |B|. See arXiv:2202.13641 and arXiv:2206.07571.
    • Random QTCodes can be constructed out of a choice of group G and one ClassicalCode only.
  • abstract.py: module for basic abstract algebra (groups, algebras, and representations thereof).
  • objects.py: module for constructing helper objects such as Cayley complexes and chain complexes, which are instrumental for the construction of various quantum codes.

🤔 Questions and issues

This project technically has a documentation page, but at the moment the documentation is largely auto-generated from source code and comments that were written to be readable in a text editor. For now, I recommend looking at the source code (and comments therein) directly, as well as the examples directory. Test files (such as qldpc/codes/quantum_test.py) also contain some examples of using the classes and methods in this library.

If you have any questions, feedback, or requests, please open an issue on GitHub or email me at mika.perlin@gmail.com!

⚓ Attribution

If you use this software in your work, please cite with:

@misc{perlin2023qldpc,
  author = {Perlin, Michael A.},
  title = {{qLDPC}},
  year = {2023},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/Infleqtion/qLDPC}},
}

This may require adding \usepackage{url} to your LaTeX file header. Alternatively, you can cite

Michael A. Perlin. qLDPC. https://github.com/Infleqtion/qLDPC, 2023.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.3.3)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for perlinm from gravatar.com perlinm

Credits

Author: Michael A. Perlin

License

Apache Software License (Apache-2.0)

Requires

Python <4.0, >=3.10

Tags

quantum computing quantum error correction low density partiy check codes LDPC

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qldpc-0.0.21.tar.gz (79.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qldpc-0.0.21-py3-none-any.whl (94.6 kB view details)

Uploaded Python 3

File details

Details for the file qldpc-0.0.21.tar.gz.

File metadata

  • Download URL: qldpc-0.0.21.tar.gz
  • Upload date:
  • Size: 79.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.0 CPython/3.12.8 Darwin/24.2.0

File hashes

Hashes for qldpc-0.0.21.tar.gz
Algorithm Hash digest
SHA256 e396615b5c9ea71890dfbcbff815255767e62bd985841adf2c789999e3dac72d
MD5 86c361cd3925f280ee0835ce2ab29cd7
BLAKE2b-256 ecccb5d426023f7d70ecc770656bd30b6cdb1a8615e29ec1f7a5de27076ad45d

See more details on using hashes here.

File details

Details for the file qldpc-0.0.21-py3-none-any.whl.

File metadata

  • Download URL: qldpc-0.0.21-py3-none-any.whl
  • Upload date:
  • Size: 94.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.0 CPython/3.12.8 Darwin/24.2.0

File hashes

Hashes for qldpc-0.0.21-py3-none-any.whl
Algorithm Hash digest
SHA256 214ab497e0697add9b899ea6709922a0051a362c68276e610a9c2dc9825ac7e4
MD5 035a982b06bc9a26c6ca793b5a48e4d7
BLAKE2b-256 3abd13fbfe9f374b34cd1bea373efa3a8c013ac270dea612568b052918418743

See more details on using hashes here.

Release history Release notifications | RSS feed

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.9

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

Pre-release

0.2.3a0

2 files

Pre-release

0.2.2rc0

2 files

Pre-release

0.2.2b0

2 files

0.2.1

2 files

0.2.0

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.29

2 files

0.0.28

2 files

0.0.27

2 files

0.0.26

2 files

0.0.25

2 files

0.0.24

2 files

0.0.23

2 files

0.0.22

2 files

This release

0.0.21 This release

2 files

0.0.20

2 files

0.0.19

2 files

0.0.18

2 files

0.0.17

2 files

0.0.16

2 files

0.0.15

2 files

0.0.14

2 files

0.0.13

2 files

0.0.12

2 files

0.0.11

2 files

0.0.10

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page