Skip to main content

Useful tools for QEC simulation

Project description

qec-util

example workflow Code style: black PyPI

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qec_util-0.5.0.tar.gz (41.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qec_util-0.5.0-py3-none-any.whl (49.4 kB view details)

Uploaded Python 3

File details

Details for the file qec_util-0.5.0.tar.gz.

File metadata

  • Download URL: qec_util-0.5.0.tar.gz
  • Upload date:
  • Size: 41.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for qec_util-0.5.0.tar.gz
Algorithm Hash digest
SHA256 969251705489a2c504c2523477232db9bc6bd7394308ca0af91e25337b347490
MD5 e8f20ecafd528ffdd67d180a43ff13b3
BLAKE2b-256 0c1a9d8a66c36a0d64bb3aa767be8edfd54908257526e0affe8427a502885881

See more details on using hashes here.

File details

Details for the file qec_util-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: qec_util-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 49.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for qec_util-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2c457ccc51aeb005e907b8e1bcf733c67993d30a20fdcd0810b986c400511e35
MD5 3197c082264e93eab5e811ba931f77a2
BLAKE2b-256 217b8cf1230b2e94e8f25dbd0b417417a7ebd9bdb32c7e789f8044beea16bcc9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page