Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pedrorrivero/pyproject-qiskit
Template for Qiskit python projects
https://github.com/pedrorrivero/pyproject-qiskit
qiskit quantum-computing
Last synced: 6 days ago
JSON representation
Template for Qiskit python projects
- Host: GitHub
- URL: https://github.com/pedrorrivero/pyproject-qiskit
- Owner: pedrorrivero
- License: apache-2.0
- Created: 2023-02-21T11:57:40.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-17T00:16:02.000Z (11 months ago)
- Last Synced: 2024-11-09T17:42:25.620Z (2 months ago)
- Topics: qiskit, quantum-computing
- Language: Python
- Homepage:
- Size: 258 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.bib
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://www.python.org/)
[](https://github.com/Qiskit/qiskit)
[](https://github.com/pedrorrivero/pyproject-qiskit/actions/workflows/test.yml)
[](https://coveralls.io/github/pedrorrivero/pyproject-qiskit?branch=main)
[](https://github.com/pedrorrivero/pyproject-qiskit/releases)
[](https://zenodo.org/)
[](LICENSE.txt)
Pyproject Qiskit
## Table of contents
1. [About this Project](#about-this-project)
2. [Installation](#installation)
3. [Documentation](#documentation)
4. [Deprecation Policy](#deprecation-policy)
5. [Contributing](#contributing)
6. [Authors and Citation](#authors-and-citation)
7. [Acknowledgements](#acknowledgements)
8. [References](#references)
9. [License](#license)
## About this Project
This template repository is a tool for creating [Qiskit](https://www.ibm.com/quantum/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](FILEMAP.md) 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](INSTALL.md).
## Documentation
- This project includes a quick [reference guide](docs/reference_guide.md) to get started with.
- Complete documentation can be found in the code docstrings.
- Check out the [file map](FILEMAP.md) 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](https://github.com/Qiskit/qiskit/blob/main/DEPRECATION.md).
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`](CHANGELOG.md).
Careful version specification is encouraged (e.g. [version pinning](https://www.easypost.com/dependency-pinning-guide)).
## Contributing
- The easiest way to contribute is by [giving feedback](CONTRIBUTING.md#giving-feedback).
- If you wish to contribute to the development of the software, you must read and follow our [contribution guidelines](CONTRIBUTING.md).
- By participating, you are expected to uphold our [code of conduct](CODE_OF_CONDUCT.md).
## Authors and Citation
This project is the work of [many people](https://github.com/pedrorrivero/pyproject-qiskit/graphs/contributors) who contribute at different levels. Please cite as per the included [BibTeX file](CITATION.bib).
## Acknowledgements
- [*Pedro Rivero*](https://github.com/pedrorrivero):
for the development of [`pyproject-qiskit`](https://github.com/pedrorrivero/pyproject-qiskit), an open-source template repository for Qiskit-based software projects.
- [*Jim Garrison*](https://github.com/garrison):
for insightful discussions and the original development of scripts for extremal version testing.
## References
[1] [Qiskit](https://github.com/Qiskit/qiskit): An Open-source Framework for Quantum Computing
## License
[Apache License 2.0](LICENSE.txt)