FlamingPy Release 0.6.1a3

[nariman87]

New features since the last release

• Fixed drawing of stabilizer graph for zero syndrome: (#9)(backward incompatible)
  • Previously, the drawing function for a stabilizer graph relied on a non-documented feature. That is, it was assumed that when building the matching graph, all edges of a Networkx-based stabilizer graph were assigned a weight. This, however, was not a fair assumption for many reasons.
  • As a solution, we have added a new method to the SurfaceCode class to draw the primal or dual stabilizer graph, which makes sure that each edge has a weight. Now, using that method, the user does not have to rely on unfair assumptions.
  • Furthermore, we added a quick check to not add any edges to the matching graph when the syndrome is trivial. In this case, the cost of decoding should be almost zero.
• Pauli noise: have added a new noise model sampling i.i.d Z error for each qubit. (#8)(backward incompatible)

Improvements

• A large number of linting corrections were made to improve the overall pylint report. These were mostly minor but essential modifications including restructuring, re-coding, optimization, updating .pylintrc, adding .coveragerc. The code quality score is improved to A for the released version. Check "Files changed" for details. (#11)

• TODO comments have been removed exclusively from files with low code quality grades. The Dev team has created tickets to be actioned for all removed TODO comments on separate (private) FlamingPy boards. (#11)

• CONTRIBUTING.md, code_of_conduct.md, and CHANGLELOG.md were imported and modified from the Strawberry Fields project. Dev team plans to extend these with customized details in future PRs. (#11)

Documentation changes

• The new Xanadu Sphinx theme has been applied. Currently, most Xanadu OSS projects include their own version of the Xanadu Sphinx theme; however, the Xanadu Sphinx Theme repository is now publicly available and is the preferred way to access the Xanadu CSS theme and Sphinx directives. (#17)

  • Deleted the doc/xanadu_theme directory
  • Updated doc/requirements.txt and doc/conf.py to reference and use the (centralized) Xanadu Sphinx Theme.
  • Replaced the Quantum Error Correction, Install, and FAQ static HTML files with reST ones.

• Updated old FT-Stack links in docs header to correct FlamingPy pages. (#7)

Contributors

This release contains contributions from (in alphabetical order):

Mikhail Andrenkov, Sebastián Duque Mesa, Nariman Saadatmand, Maxime Tremblay, Ilan Tzitrin

See full commit details here.

---

This discussion was created from the release FlamingPy Release 0.6.1a3 .