qLDPC

This package contains tools for constructing and analyzing quantum low density parity check (qLDPC) codes.

📦 Installation

This package requires Python>=3.10, and can be installed from PyPI with

pip install qldpc

To install a local version 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.
  • CSSCode: general class for constructing quantum CSS codes out of two mutually compatible ClassicalCodes.
    • CSSCode.get_logical_ops: method to construct a complete basis of nontrivial logical operators for a CSSCode.
    • 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). Options to apply more general Clifford code deformations are pending.
  • GBCode: class for constructing generalized bicycle codes, as described in arXiv:1904.02703.
  • QCCode: class for constructing the quasi-cyclic codes in arXiv:2308.07915 and arXiv:2311.16980.
    • Includes methods to identify "toric layouts" of a QCCode, 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 and helper objects such as Cayley complexes and chain complexes, which are instrumental for the construction of various quantum codes.

🤔 Questions and issues

If this project gains interest and traction, I'll add a documentation webpage and material to help users get started quickly. I am also planning to write a paper that presents and explains this project. In the meantime, you can explore the documentation and explanations in the source code, as well as the examples directory. Test files (such as qldpc/codes/quantum_test.py) contain some examples of using the classes and methods described above.

If you have any questions, feedback, or requests, please open an issue on GitHub or email me at michael.perlin@infleqtion.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.12.tar.gz (68.4 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.12-py3-none-any.whl (78.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: qldpc-0.0.12.tar.gz
  • Upload date:
  • Size: 68.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.8 Linux/6.8.0-zen1

File hashes

Hashes for qldpc-0.0.12.tar.gz
Algorithm Hash digest
SHA256 b1bd2174d2656ae92fa6e5195cfa50cacd8ebbde106d659c401d20ea72d8395d
MD5 094b52aa84ac827f491e1ff74222966b
BLAKE2b-256 b96eafe82f8db15b3e8a1ac449e40b1edca0efe793c0474ef11dc8e830b2a231

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qldpc-0.0.12-py3-none-any.whl
  • Upload date:
  • Size: 78.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.8 Linux/6.8.0-zen1

File hashes

Hashes for qldpc-0.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 512c60042567d5a1bb05ca79610a3e67d18cd6428555c40a8156b5c325877711
MD5 74730202f3484249989dd852d74bcf78
BLAKE2b-256 5c40686d4b4b4ae5180d192bd515a88fa9130ac204d917f8980c67c7893ef1e5

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

0.0.21

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

This release

0.0.12 This release

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