FlamingPy Documentation



Responsive image

FlamingPy (FP) is a cross-platform Python library with a variety of backends for efficient simulations of error correction in fault-tolerant quantum computers.


  • Simulates error correction on combinations of CV and DV codes to obtain estimations of fault-tolerant thresholds.

  • Supports encoding qubits into GKP states (more precisely, combinations of GKP and squeezed states).

  • Is conveniently modularized, allowing the user to insert custom noise models, codes, decoders, backends and other features.

  • Provides a host of visualization tools for ease of verifying correctness.


If you are having issues, please let us know by posting the issue on our GitHub Issue Tracker.

We also have a #flamingpy channel on the Xanadu Slack, GitHub Discussion Pages, and a Discussion Forum, all great places to start a general discussion and connect with our community members.

Attribution for authors

FlamingPy is the work of many contributors. If you are doing research using FlamingPy, please cite our paper below:

Ilan Tzitrin, Takaya Matsuura, Rafael N. Alexander, Guillaume Dauphinais, J. Eli Bourassa, Krishna K. Sabapathy, Nicolas C. Menicucci, and Ish Dhand, Fault-Tolerant Quantum Computation with Static Linear Optics, PRX Quantum, Vol. 2, No. 4, 2021, DOI:10.1103/prxquantum.2.040353

In addition to the authors above, the developers would like to thank Sanchit Bapat, Ashlesha Patil, Michael Vasmer, and Trevor Vincent for their contributions to the pre-release project.


FlamingPy is free and open source, and released under the Apache License, Version 2.0.