Welcome to QECC’s documentation

QECC is a tool for quantum error correcting codes developed as part of the Munich Quantum Toolkit (MQT) by the Chair for Design Automation at the Technical University of Munich. It builds upon MQT Core, which forms the backbone of the MQT.

We recommend you to start with the installation instructions. Then proceed to read the reference documentation. If you are interested in the theory behind QECC, have a look at the publications in the publication list.

We appreciate any feedback and contributions to the project. If you want to contribute, you can find more information in the Contribution guide. If you are having trouble with the installation or the usage of QECC, please let us know at our Support page or by reaching out to us at quantum.cda@xcit.tum.de.

---

User Guide

• Installation
  • A Detailed Walk Through
  • Building from Source for Performance
• LightsOut decoder for quantum codes
  • Quantum Codes
  • LightsOut puzzle
  • Using QECC to decode quantum codes using the LightsOut solution
• ECC Framework
  • Usage
  • Supported ECCs
• Publications

Developers

• Contributing
  • Types of Contributions
  • 🎉 Get Started
  • Core Guidelines
  • Pull Request Workflow
• Development Guide
  • Initial Setup
  • Working on the core C++ library
  • Working on the Python module
  • Working on the Documentation
• Support

API Reference

• Library
  • apply_ecc
    • apply_ecc()
  • Code
    • Code
      • Code.d
      • Code.getHx()
      • Code.getHz()
      • Code.get_syndrome()
      • Code.get_x_syndrome()
      • Code.is_stabilizer()
      • Code.is_x_stabilizer()
      • Code.json()
      • Code.k
      • Code.n
      • Code.setHx()
      • Code.setHz()
  • Decoder
    • Decoder
      • Decoder.decode()
      • Decoder.growth
      • Decoder.result
      • Decoder.set_code()
      • Decoder.set_growth()
  • UFHeuristic
    • UFHeuristic
      • UFHeuristic.decode()
      • UFHeuristic.growth
      • UFHeuristic.reset()
      • UFHeuristic.result
  • UFDecoder
    • UFDecoder
      • UFDecoder.decode()
      • UFDecoder.growth
      • UFDecoder.result
  • GrowthVariant
    • GrowthVariant
      • GrowthVariant.ALL_COMPONENTS
      • GrowthVariant.INVALID_COMPONENTS
      • GrowthVariant.SINGLE_QUBIT_RANDOM
      • GrowthVariant.SINGLE_RANDOM
      • GrowthVariant.SINGLE_SMALLEST
      • GrowthVariant.name
      • GrowthVariant.value
  • DecodingResult
    • DecodingResult
      • DecodingResult.decoding_time
      • DecodingResult.estim_vec_idxs
      • DecodingResult.estimate
      • DecodingResult.json()
  • DecodingResultStatus
    • DecodingResultStatus
      • DecodingResultStatus.ALL_COMPONENTS
      • DecodingResultStatus.INVALID_COMPONENTS
      • DecodingResultStatus.name
      • DecodingResultStatus.value
  • DecodingRunInformation
    • DecodingRunInformation
      • DecodingRunInformation.codeSize
      • DecodingRunInformation.error
      • DecodingRunInformation.json()
      • DecodingRunInformation.physicalErrR
      • DecodingRunInformation.result
      • DecodingRunInformation.status
      • DecodingRunInformation.syndrome
  • sample_iid_pauli_err
    • sample_iid_pauli_err()
  • LightsOut Decoder
    • LightsOut
      • LightsOut.complete_parity_constraint()
      • LightsOut.count_switches()
      • LightsOut.preconstruct_parity_constraint()
      • LightsOut.preconstruct_z3_instance()
      • LightsOut.solve()
      • LightsOut.validate_model()
    • run()