Skip to content

A template repository for generating new quantum prototypes based on Qiskit

License

Notifications You must be signed in to change notification settings

qiskit-community/quantum-prototype-template

Repository files navigation

Platform Python Qiskit License Code style: Black Tests Coverage

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 automated testing software. Check out the file glossary 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
  2. Beginner's Guide
  3. Installation
  4. Quickstart Guide
  5. Tutorials
  6. How-Tos
  7. Prototype Template File Glossary
  8. How to Give Feedback
  9. Contribution Guidelines
  10. References and Acknowledgements
  11. License
For Developers/Contributors
  1. Contribution Guide
  2. Technical Docs

How to Give Feedback

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


Contribution Guidelines

For information on how to contribute to this project, please take a look at our contribution guidelines.


References and Acknowledgements

[1] Diátaxis Technical Documentation Framework
https://diataxis.fr/


License

Apache License 2.0

About

A template repository for generating new quantum prototypes based on Qiskit

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages