pyproject-qiskit
Template for Qiskit python projects
Science Score: 41.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
-
○DOI references
-
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.1%) to scientific vocabulary
Keywords
Repository
Template for Qiskit python projects
Basic Info
Statistics
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
Pyproject Qiskit
Table of contents
- About this Project
- Installation
- Documentation
- Deprecation Policy
- Contributing
- Authors and Citation
- Acknowledgements
- References
- License
About this Project
This template repository is a tool for creating Qiskit-based Python projects quickly. It provides much of the necessary boilerplate code and configurations needed for a fully functional, professional, software.
It was originally put together for quick development of Quantum Software Prototypes: collaborations between developers and researchers to bring users early access to solutions from cutting-edge research.
Check out the file map for more information on the structure of the repository.
Some projects using this template
- [Quantum Enablement](https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement) - [Prototype ZNE](https://github.com/qiskit-community/prototype-zne) - [PR Toolbox](https://github.com/pedrorrivero/pr-toolbox) - [Staged Primitives](https://github.com/Qiskit-Extensions/staged-primitives)Installation
The latest version of this software can be easily installed, alongside all required dependencies, via pip:
pip install pyproject-qiskit@git+https://github.com/pedrorrivero/pyproject-qiskit
For more detailed information and alternative installation options see the installation guide.
Documentation
- This project includes a quick reference guide to get started with.
- Complete documentation can be found in the code docstrings.
- Check out the file map for more information on the structure of this repository.
Deprecation Policy
This software is meant to evolve rapidly and, as such, does not follow Qiskit's deprecation policy.
We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in CHANGELOG.md.
Careful version specification is encouraged (e.g. version pinning).
Contributing
- The easiest way to contribute is by giving feedback.
- If you wish to contribute to the development of the software, you must read and follow our contribution guidelines.
- By participating, you are expected to uphold our code of conduct.
Authors and Citation
This project is the work of many people who contribute at different levels. Please cite as per the included BibTeX file.
Acknowledgements
- Pedro Rivero:
for the development of
pyproject-qiskit, an open-source template repository for Qiskit-based software projects. - Jim Garrison: for insightful discussions and the original development of scripts for extremal version testing.
References
[1] Qiskit: An Open-source Framework for Quantum Computing
License
Owner
- Name: Pedro Rivero
- Login: pedrorrivero
- Kind: user
- Location: New York, USA / Madrid, Spain
- Company: IBM Research
- Website: www.linkedin.com/in/pedrorrivero/
- Repositories: 3
- Profile: https://github.com/pedrorrivero
Quantum Developer | Error mitigation
Citation (CITATION.bib)
@misc{pyproject_qiskit,
author = {Pedro Rivero},
title = {Python Project},
year = {2024},
publisher = {Zenodo},
version = {0.0.0},
doi = {},
url = {https://github.com/pedrorrivero/pyproject-qiskit},
}
GitHub Events
Total
- Watch event: 1
Last Year
- Watch event: 1
Issues and Pull Requests
Last synced: 12 months ago
All Time
- Total issues: 0
- Total pull requests: 6
- Average time to close issues: N/A
- Average time to close pull requests: 1 day
- Total issue authors: 0
- Total pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.17
- Merged pull requests: 6
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
- pedrorrivero (8)
- akotil (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v3 composite
- actions/upload-artifact v2 composite
- actions/checkout v3 composite
- actions/setup-python v2 composite
- coverallsapp/github-action master composite
- actions/checkout v3 composite
- actions/setup-python v2 composite
- actions/checkout v3 composite
- eloquent/github-release-action v3 composite
- AndreasAugustin/actions-template-sync v0.7.3 composite
- actions/checkout v3 composite
- actions/checkout v3 composite
- actions/setup-python v1 composite
- actions/checkout v3 composite
- actions/setup-python v1 composite
- actions/checkout v3 composite
- actions/setup-python v1 composite
- qiskit >= 0.45.1