https://github.com/cqcl/qermit
Python module for running error-mitigation protocols with the pytket quantum SDK
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.5%) to scientific vocabulary
Keywords from Contributors
Repository
Python module for running error-mitigation protocols with the pytket quantum SDK
Basic Info
Statistics
- Stars: 48
- Watchers: 12
- Forks: 12
- Open Issues: 55
- Releases: 7
Metadata Files
README.md
Qermit
Qermit is a python module for running error-mitigation protocols on quantum processors. It is an extension to the pytket quantum computing toolkit.
This repository contains source code and API documentation.
For details on building the docs please see docs/README.md
Getting Started
To install, run:
pip install qermit
You may also wish to install the package from source:
pip install -e .
A poetry.lock file is included for use with poetry.
API documentation can be found at qerm.it.
Bugs
Please file bugs on the Github issue tracker.
Contributing
Pull requests or feature suggestions are very welcome. To make a PR, first fork the repository, make your proposed changes, and open a PR from your fork.
Code style
Style checks are run by continuous integration.
To install the dependencies required to run them locally run:
pip install qermit[tests]
Formatting
This repository uses ruff for formatting and linting.
To check if your changes meet these standards run:
ruff check
ruff format --check
Type annotation
mypy is used as a static type checker.
mypy -p qermit
Tests
Tests are run by continuous integration.
To install the dependencies required to run them locally run:
pip install qermit[tests]
To run tests use:
cd tests
pytest
When adding a new feature, please add a test for it. When fixing a bug, please add a test that demonstrates the fix.
How to cite
If you wish to cite Qermit, we recommend citing our benchmarking paper where possible.
Owner
- Name: Cambridge Quantum
- Login: CQCL
- Kind: organization
- Location: Cambridge, UK
- Website: http://www.cambridgequantum.com
- Repositories: 48
- Profile: https://github.com/CQCL
Quantum Software and Technologies
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Dan Mills | 5****c | 50 |
| dependabot[bot] | 4****] | 40 |
| Silas Dilkes | 3****s | 37 |
| hugrbot | C****g@q****m | 5 |
| dan-mills-cqc | d****s@d****e | 5 |
| dan-mills-cqc | d****s@D****l | 3 |
| Daniel Mills | d****s@D****n | 2 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 49
- Total pull requests: 298
- Average time to close issues: 28 days
- Average time to close pull requests: 9 days
- Total issue authors: 5
- Total pull request authors: 7
- Average comments per issue: 0.1
- Average comments per pull request: 0.43
- Merged pull requests: 172
- Bot issues: 0
- Bot pull requests: 147
Past Year
- Issues: 45
- Pull requests: 195
- Average time to close issues: 23 days
- Average time to close pull requests: 6 days
- Issue authors: 3
- Pull request authors: 5
- Average comments per issue: 0.09
- Average comments per pull request: 0.41
- Merged pull requests: 87
- Bot issues: 0
- Bot pull requests: 147
Top Authors
Issue Authors
- daniel-mills-cqc (42)
- AiPals (2)
- CalMacCQ (2)
- irfankhan10 (2)
- sjdilkes (1)
Pull Request Authors
- dependabot[bot] (147)
- daniel-mills-cqc (94)
- sjdilkes (42)
- hugrbot (9)
- CalMacCQ (4)
- cqc-melf (1)
- ss2165 (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- sphinx *
- sphinx_autodoc_annotation *
- sphinx_rtd_theme *
- matplotlib *
- networkx *
- pytket *
- pytket *
- pytest * test
- pytket-qiskit * test
- actions/checkout v2 composite
- actions/setup-python v2 composite