tqec

Design automation software tools for Topological Quantum Error Correction

Live endpoint: https://tqec.app

Installation

Backend (Python package)

In order to install the tqec package, you can follow the following instructions.

First, clone this repository on your computer and go in the newly created folder:

git clone https://github.com/QCHackers/tqec.git
cd tqec

If not already done, create a clean Python virtual environment to avoid any version clash between packages. You can use the default Python package venv to do that:

python -m venv venv        # Create a "venv" directory in the current directory.
source venv/bin/activate   # On Unix. For Windows users, use activate.bat

You might see a (venv) appearing on your terminal prompt, showing that the virtual environment has been activated.

The next step is to install the package and its dependencies using

python -m pip install "."

If you want to help developing the tqec Python package, you should install the development environment by using instead

python -m pip install ".[dev]"
pre-commit install

If no errors happen, the package is installed! You can try to launch a jupyter lab server

python -m jupyter lab

and to run some of the notebooks in the notebooks directory.

Frontend

Refer to this folder for instructions.

Architecture

Refer to this wiki page for more information.

Helpful Links

1. Google group
2. Introduction to TQEC
3. Overview of state of the art 2D QEC
4. Backend deep dive
5. Developer documentation for the tqec project

Before you commit

nbdime is a great tool for looking at the git diff for jupyter notebooks.

For jupyterlab there is a market place extension which you need to enable first and that will let you search and install extensions from within jupyter lab. You can enable the marketplace extension with the following code: