https://github.com/strilanc/yoked-surface-codes
Source code written as part of the paper "Yoked Surface Codes"
https://github.com/strilanc/yoked-surface-codes
Last synced: 9 months ago
JSON representation
Source code written as part of the paper "Yoked Surface Codes"
- Host: GitHub
- URL: https://github.com/strilanc/yoked-surface-codes
- Owner: Strilanc
- Created: 2023-12-07T01:31:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-07T01:31:50.000Z (over 2 years ago)
- Last Synced: 2025-06-12T18:11:28.296Z (12 months ago)
- Language: Python
- Size: 5.04 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Code repository for "Yoked Surface Codes"
This repository contains code to generate circuits, the data for, and code to plot the figures
appearing in the paper "Yoked Surface Codes".
## Reproducing figures
Sitting next to this README, at the root of the repository,
are several folders. `assets` contains the paper figures, along
with the data used to produce them as `.csv` files. Run the `make_paper_figures`
script to regenerate these plots. The stats have been partitioned based on which
figure they are used in - one can also inspect the script to see what each `.csv`
data file corresponds to and how that data is used.
There are also a series of scripts for producing gap distributions,
as well as performing circuit simulations of yoking as described in the paper.
However, these do not include the gap simulations, nor can they produce the gap distribution
for a correlated minimum-weight perfect matching decoder, as these use internal tools.
A warning - this repo was 're-focused' halfway through the project. Consequently, there are
commands that allow for constructions not discussed in the paper. One example
is the functionality surrounding single Y-type yokes. The code is brittle, and
we emphasize caution when using these 'additional' functionalities - they have not been updated.
To install the requirements:
```bash
python -m venv .venv
source .venv/bin/activate
sudo apt install parallel
pip install -r requirements.txt
```
## Directory structure
- `.`: top level of repository, with this README and the generation scripts
- `./assets`: contains plots from the paper, the data used to generate them, and a .skp file rendering the topological diagrams in SketchUp
- `./out`: scripts are configured to create this directory and write their output to various locations within it
- `./src`: source root of the code; the directory to include in `PYTHONPATH`
- `./src/yoked`: code for generating and debugging yoked surface code circuits
- `./src/gen`: utility code for generating and debugging circuits
- `./tools`: tools used by the top-level scripts to perform tasks such as generating circuits and plots