qec-util

A collection of utility methods and objects to aid with the simulation, decoding and analysis of QEC experiments.

Installation

This package is available in PyPI, thus it can be installed using

pip install qec-util[all]

or alternatively, it can be installed from source using

git clone git@github.com:MarcSerraPeralta/qec-util.git
cd qec-util
pip install .[all]

The flag [all] is to install the requirements to be able to run all functionality from qec_util. If only specific functions are going to be used, it is recommended to run

pip install qec-util
pip install ... # requirements specified in the Notes of the specific functions

Setting up the gurobi license

1. Create a free academic account
2. Request a license, which will give you a license key
3. Install the Gurobi Optimizer (or install gurobipy through conda) so that we can run the grbgetkey command
4. Run grbgetkey xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx using your license number
5. At the end of ~/.bashrc add export GRB_LICENSE_FILE=/path/to/license.lic where the license path is printed when running the previous step
6. Run source ~/.bashrc or open a new terminal and check that the license installation is successful by running the gurobi.sh command