Skip to content

pedrorrivero/pr-toolbox

Repository files navigation

Platform Python Qiskit Terra
Tests Coverage Release DOI License


Logo

PR-Toolbox


Table of contents

  1. About This Project
  2. About Prototypes
  3. Deprecation Policy
  4. Using Quantum Services
  5. Acknowledgements
  6. References
  7. License

For users

  1. Installation
  2. Tutorials
  3. Reference Guide
  4. How-tos
  5. Explanations
  6. How to Give Feedback

For developers

  1. Contribution Guidelines

About This Project

This toolbox has been put together throughout years of research and software development experience in the field of Quantum Information Science and Computing. While we do not expected it to be comprehensive —building on top of other quantum computing frameworks instead, mostly Qiskit— the author hopes to serve at least a number of purposes:

  1. Help bridge two equally important domains in the Quantum industry: research and development (sometimes at odds with each other).
  2. Serve as a playground to explore an develop new concepts and ideas.
  3. Communicate with users, listen to their needs, and propose solutions.

To these ends, the toolbox exposes libraries and frameworks with versatile and efficient functionality for many different tasks, including but not limited to:

  • Classical computing:
    • Class design artifacts
    • Design-pattern implementation utilities
    • Serialization capabilities
    • Validation tools
  • Quantum computing:
    • Circuit construction and analysis
    • Operator parsing
    • Result computation

About Prototypes

Prototypes is a collaboration between developers and researchers that will give users early access to solutions from cutting-edge research in areas like error mitigation, quantum simulation, and machine learning. These software packages are built on top of, and may eventually be integrated into the Qiskit SDK. They are a contribution as part of the Qiskit community.

Check out our landing page and blog post for more information!


Deprecation Policy

Prototypes are meant to evolve rapidly and, as such, do 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.


Using Quantum Services

If you are interested in using quantum services (i.e. using a real quantum computer, not a simulator) you can look at the Qiskit Partners program for partner organizations that have provider packages available for their offerings.

Importantly, Qiskit IBM Runtime is a quantum computing service and programming model that allows users to optimize workloads and efficiently execute them on quantum systems at scale; extending the existing interface in Qiskit with a set of new primitive programs.


Acknowledgements

  • Bob Alice: for scientific insight and guidance.

References

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


License

Apache License 2.0