This repository hosts Qiskit Function templates and template implementations powered by qiskit and qiskit-serverless.
Qiskit Function template implementations are realistic examples of how to build utility-scale application workflows with Qiskit and Qiskit addons. These are prebuilt workflows that you can customize for your own research needs instead of starting from scratch. To simplify execution and parallelization, they are easily deployable to Qiskit Serverless.
Implementations are organized by application area, which currently includes:
physicschemistry
Each implementation is contained in a directory in the corresponding application area. For example, the Hamiltonian simulation function is contained in 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:
Want to build your own custom Qiskit Function? The base templates are references you can use 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 that the CI/CD implementation can be easily extended to match your projects.
There are currently two templates: a circuit function template and an application function template.
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.