- About this Project
- Installation
- Documentation
- Deprecation Policy
- Contributing
- Authors and Citation
- Acknowledgements
- References
- License
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
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.
- 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.
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).
- 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.
This project is the work of many people who contribute at different levels. Please cite as per the included BibTeX file.
- 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.
[1] Qiskit: An Open-source Framework for Quantum Computing