Welcome to the PECOS Docs!

PECOS, which stands for “Performance Estimator of Codes On Surfaces,” is a Python package that provides a framework for studying, developing, and evaluating quantum error-correcting codes (QECCs).

PECOS is an attempt at balancing simplicity, usability, functionality, and extendibility as well as future-proofing. In the spirit of extendibility, PECOS is agnostic to quantum simulators, quantum operations, and QECCs. Of course, it is difficult to eloquently represent all QEC techniques. While agnostic to QECCs, the primary focus of PECOS has been the simulation and evaluation of lattice-surgery for topological stabilizer codes.

History

The first incarnation of PECOS was created by Ciarán Ryan-Anderson in June 2014 to verify the lattice-surgery procedures in arXiv:1407.5103 [LRA14].

Make this Documentation

To build this documentation go to the docs folder and run:

>>> make clean
>>> make html

What’s Next?

To get started, check out the following:

• Getting Started
  • Language Requirement
  • Package Requirements
  • Note on Python Distribution/Environment
  • Installing and Uninstalling
  • Development Branch
  • Tests
  • Importing
• API Guide
  • Quantum Circuits
  • QECCs
  • Logical Circuits
  • Simulators
  • Standard Gates
  • Circuit Runners
  • Error Generators
  • Decoders
  • Tools
• Examples
  • Verifying a Stabilizer Code
  • Creating a QECC Class
  • Gate-wise Error Models
  • Monte Carlo Script
• Change Log
  • Planned Features
  • Releases
• Bibliography
• Todo List

Indices and tables

• Index
• Module Index
• Search Page