Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/qiskit-community/quantum-prototype-template

A template repository for generating new quantum prototypes based on Qiskit
https://github.com/qiskit-community/quantum-prototype-template

qiskit quantum-computing

Last synced: 17 days ago
JSON representation

A template repository for generating new quantum prototypes based on Qiskit

Lists

README 

        
![Platform](https://img.shields.io/badge/Platform-Linux%20%7C%20macOS%20%7C%20Windows-informational)

[![Python](https://img.shields.io/badge/Python-3.8%20%7C%203.9%20%7C%203.10-informational)](https://www.python.org/)

[![Qiskit](https://img.shields.io/badge/Qiskit-%E2%89%A5%201.0.0-6133BD)](https://github.com/Qiskit/qiskit)

[![License](https://img.shields.io/github/license/qiskit-community/quantum-prototype-template?label=License)](https://github.com/qiskit-community/quantum-prototype-template/blob/main/LICENSE.txt)

[![Code style: Black](https://img.shields.io/badge/Code%20style-Black-000.svg)](https://github.com/psf/black)

[![Tests](https://github.com/qiskit-community/quantum-prototype-template/actions/workflows/test_latest_versions.yml/badge.svg)](https://github.com/qiskit-community/quantum-prototype-template/actions/workflows/test_latest_versions.yml)

[![Coverage](https://coveralls.io/repos/github/qiskit-community/quantum-prototype-template/badge.svg?branch=main)](https://coveralls.io/github/qiskit-community/quantum-prototype-template?branch=main)



# Quantum Prototype Template



This template repository is a tool for creating Python projects quickly by providing much of the necessary boilerplate code. The code examples in this template repository are written in accordance with pylint style checks, and the sample `prototype_template` module has an associated unit test module. We have also included examples of coverage testing, notebook tests, and notebook lint checks and wrapped all of these using [tox](https://github.com/tox-dev/tox) automated testing software. Check out the [file glossary](https://github.com/qiskit-community/quantum-prototype-template/blob/main/docs/file-map-and-description.md) for more information on each tool used in this repository.



We encourage you to use this template repository to begin your own research projects!



### Table of Contents



##### For Users



1.  [About the Project](docs/project_overview.md)

2.  [Beginner's Guide](docs/beginners_guide.md)

3.  [Installation](INSTALL.md)

4.  [Quickstart Guide](docs/quickstart_guide.md)

5.  [Tutorials](docs/tutorials/example_tutorial.ipynb)

6.  [How-Tos](docs/how_tos/example_how_to.ipynb)

7.  [Prototype Template File Glossary](docs/file-map-and-description.md)

8.  [How to Give Feedback](#how-to-give-feedback)

9.  [Contribution Guidelines](#contribution-guidelines)

10. [References and Acknowledgements](#references-and-acknowledgements)

11. [License](#license)



##### For Developers/Contributors



1. [Contribution Guide](CONTRIBUTING.md)

2. [Technical Docs](docs/technical_docs.md)



----------------------------------------------------------------------------------------------------



### How to Give Feedback



We encourage your feedback! You can share your thoughts with us by:

- [Opening an issue](https://github.com/qiskit-community/quantum-prototype-template/issues) in the repository



----------------------------------------------------------------------------------------------------



### Contribution Guidelines



For information on how to contribute to this project, please take a look at our [contribution guidelines](CONTRIBUTING.md).



----------------------------------------------------------------------------------------------------



## References and Acknowledgements

[1] Diátaxis Technical Documentation Framework \

    https://diataxis.fr/



----------------------------------------------------------------------------------------------------



### License

[Apache License 2.0](LICENSE.txt)