Qsurface

This package provides capabilities for simulating and visualizing quantum error correction on surface codes. It is designed with a modular structure, separating the surface code definition, the error model, and the decoder implementation. This allows researchers to easily integrate and test new types of surface codes, error models, or decoding algorithms.

The library includes implementations of several decoders:

• The Minimum-Weight Perfect Matching (MWPM) decoder.
• The standard Union-Find decoder, known for its near-linear worst-case time complexity.
• The Union-Find Node-Suspension (UFNS) decoder, a modification that aims to improve the threshold performance while retaining quasi-linear complexity.

Users can perform simulations with various error rates and error types (e.g., Pauli errors). The package also supports benchmarking decoder performance, including metrics like decoding duration and success rate.

A key feature is the step-by-step visualization of the surface code state and the decoding process. This includes support for 3D plotting when simulating faulty measurements. The visualization tools allow users to inspect the state at each iteration and navigate through the history.

Simulations can be run programmatically within Python or via a command-line interface.