This repository hosts Qiskit Function templates and template implementations powered by qiskit and qiskit-serverless.
Template implementations are realistic examples of how to build utility-scale application workflows with Qiskit and Qiskit Addons. Spanning across application domains, these are starter kits that you can customize for your own research needs instead of starting from scratch. And they are easily deployable to Qiskit Serverless for managed execution.
The base templates are references you can use for developing custom Qiskit Functions using recommended best practices.
Qiskit Function base templates allow to kickstart the Qiskit Function development process with best-practices in interface development, code formatting, unit testing, and more. The repository itself is exposed as a GitHub template, so the CI/CD implementation can be easily extended by implementers to match new projects.
There are currently two templates: a circuit function template and an application function template.
Qiskit Function template implementations show different realizations of the application function template above that leverage Qiskit Addons to run industry-relevant application workflows. These implementations are structured by application area, currently:
physicschemistry
Each implementation is contained in a directory in the corresponding application area, for example, for the hamiltonian simulation function: physics/hamiltonian_simulation. The directory might contain additional files that can be uploaded to the serverless environment for the function execution.
For convenience, we provide direct download links for each application template directory:
All documentation is available at [TBD].
The source code is available on GitHub.
The developer guide is located at CONTRIBUTING.md in the root of this project's repository. By participating, you are expected to uphold Qiskit's code of conduct.
We use GitHub issues for tracking requests and bugs.