Data

Tools

Indexes

Applications

Experiments

Open Source Science

qec-util

Useful tools for QEC simulation with Stim

https://github.com/marcserraperalta/qec-util

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.6%) to scientific vocabulary

Keywords

qec qecc quantum-error-correction stim util utils
Last synced: 6 months ago · JSON representation ·

Repository

Useful tools for QEC simulation with Stim

Basic Info
  • Host: GitHub
  • Owner: MarcSerraPeralta
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 193 KB
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 0
  • Open Issues: 5
  • Releases: 3
Topics
qec qecc quantum-error-correction stim util utils
Created over 1 year ago · Last pushed 8 months ago
Metadata Files
Readme License Citation

README.md

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

Owner

  • Name: MarcSerraPeralta
  • Login: MarcSerraPeralta
  • Kind: user
  • Location: Spain

Citation (CITATION.cff) 

cff-version: 1.2.0
title: qec-util
message: >-
  Useful tools for QEC simulation with Stim
type: software
authors:
  - given-names: Marc
    family-names: Serra-Peralta
    email: M.SerraPeralta@tudelft.nl
    affiliation: 'QuTech, Delft University of Technology'
    orcid: 'https://orcid.org/0000-0002-8000-8701'
repository-code: "https://github.com/MarcSerraPeralta/qec-util"
abstract: >-
  A collection of utility methods and objects to aid with the simulation, decoding and analysis of QEC experiments.
keywords:
  - quantum
  - quantum-computing
  - quantum-error-correction
  - stim
license: MIT

GitHub Events

Total
  • Create event: 33
  • Release event: 3
  • Issues event: 30
  • Watch event: 2
  • Delete event: 31
  • Issue comment event: 19
  • Push event: 31
  • Pull request event: 55
Last Year
  • Create event: 33
  • Release event: 3
  • Issues event: 30
  • Watch event: 2
  • Delete event: 31
  • Issue comment event: 19
  • Push event: 31
  • Pull request event: 55

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 20
  • Total pull requests: 29
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 24 minutes
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 28
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 19
  • Pull requests: 29
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 24 minutes
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.47
  • Average comments per pull request: 0.0
  • Merged pull requests: 28
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • MarcSerraPeralta (35)
Pull Request Authors
  • MarcSerraPeralta (46)
Top Labels
Issue Labels
enhancement (15) bug (8) documentation (5) question (3) testing (1)
Pull Request Labels
enhancement (29) bug (11) documentation (3) testing (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 21 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 5
  • Total maintainers: 1
pypi.org: qec-util

Useful tools for QEC simulation

  • Documentation: https://qec-util.readthedocs.io/
  • License: MIT License Copyright (c) 2023 MarcSerraPeralta Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 0.4.1
    published 8 months ago
  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 21 Last month
Rankings
Dependent packages count: 10.5%
Average: 34.7%
Dependent repos count: 58.9%
Maintainers (1)
MarcSerraPeralta
Last synced: 6 months ago

Dependencies

pyproject.toml pypi
  • black ^22.12.0 develop
  • codecov ^2.1.12 develop
  • darglint ^1.8.1 develop
  • flake8 ^6.0.0 develop
  • flake8-annotations ^2.9.1 develop
  • flake8-bandit ^4.1.1 develop
  • flake8-black ^0.3.6 develop
  • flake8-bugbear ^22.12.6 develop
  • flake8-docstrings ^1.6.0 develop
  • flake8-import-order ^0.18.2 develop
  • mypy ^0.991 develop
  • pytest ^7.2.0 develop
  • pytest-cov ^4.0.0 develop
  • sphinx ^6.1.3 develop
  • sphinx-autodoc-typehints ^1.20.1 develop
  • typeguard ^2.13.3 develop
  • xdoctest ^1.1.0 develop
  • lmfit ^1.1.0
  • matplotlib ^3.6.3
  • networkx ^3.0
  • numpy >=1.19, <1.25
  • python >=3.8.1, <3.11
  • pyyaml ^6.0
  • xarray ^0.21
requirements.txt pypi
  • asteval ==1.0.2
  • contourpy ==1.2.1
  • cycler ==0.12.1
  • dill ==0.3.8
  • fonttools ==4.53.1
  • kiwisolver ==1.4.5
  • lmfit ==1.3.2
  • matplotlib ==3.9.2
  • networkx ==3.3
  • numpy ==2.0.1
  • packaging ==24.1
  • pandas ==2.2.2
  • pillow ==10.4.0
  • pyparsing ==3.1.2
  • python-dateutil ==2.9.0.post0
  • pytz ==2024.1
  • pyyaml ==6.0.2
  • scipy ==1.14.0
  • six ==1.16.0
  • tzdata ==2024.1
  • uncertainties ==3.2.2
  • xarray ==2024.7.0
requirements_dev.txt pypi
  • asteval ==1.0.2 development
  • black ==24.8.0 development
  • build ==1.2.1 development
  • click ==8.1.7 development
  • cloudpickle ==3.0.0 development
  • contourpy ==1.2.1 development
  • cycler ==0.12.1 development
  • dill ==0.3.8 development
  • fonttools ==4.53.1 development
  • iniconfig ==2.0.0 development
  • jinja2 ==3.1.4 development
  • kiwisolver ==1.4.5 development
  • lmfit ==1.3.2 development
  • markdown-it-py ==3.0.0 development
  • markupsafe ==2.1.5 development
  • matplotlib ==3.9.2 development
  • mdurl ==0.1.2 development
  • mypy-extensions ==1.0.0 development
  • networkx ==3.3 development
  • numpy ==1.26.4 development
  • packaging ==24.1 development
  • pandas ==2.2.2 development
  • pathspec ==0.12.1 development
  • pillow ==10.4.0 development
  • pip-tools ==7.4.1 development
  • platformdirs ==4.2.2 development
  • pluggy ==1.5.0 development
  • psutil ==6.0.0 development
  • pygments ==2.18.0 development
  • pyparsing ==3.1.2 development
  • pyproject-hooks ==1.1.0 development
  • pytest ==8.3.2 development
  • pytest-black ==0.3.12 development
  • python-dateutil ==2.9.0.post0 development
  • pytz ==2024.1 development
  • pyyaml ==6.0.2 development
  • rich ==13.7.1 development
  • scalene ==1.5.44 development
  • scipy ==1.14.0 development
  • six ==1.16.0 development
  • toml ==0.10.2 development
  • tzdata ==2024.1 development
  • uncertainties ==3.2.2 development
  • wheel ==0.44.0 development
  • xarray ==2024.7.0 development