Skip to main content
IBM Quantum Platform

Introduction to Qiskit Function templates

Qiskit Function templates are an open-source collection of realistic code examples that give you access to some of the latest research workflows that leverage tools like the Qiskit SDK and Qiskit addons. These pre-built workflows take information from practical experiments and package them in a way that you can customize and reuse in your own research so that you don't have to build from scratch. All templates are readily deployable to Qiskit Serverless where you can easily leverage classical compute as part of your workflow.

There are two types of templates:

  • Template implementations: Specialized code examples that implement advanced techniques from real-world experiments in areas like chemistry and physics.
  • Base templates: References for developing your own original Qiskit Function. These templates highlight best-practices in interface development, code formatting, unit testing, and more.

Template implementations

Qiskit Function template implementations are organized by application area. Currently included in the collection is a physics template for Hamiltonian simulation using the AQC-Tensor Qiskit addon and a chemistry template for electronic structure with the implicit solvent model using the SQD Qiskit addon. Resources to get started with these two templates are available at the following links:


Base templates

The base templates are references for developing your own original Qiskit Function. They are designed to help you kickstart the development process by illustrating best practices in interface development, code formatting, I/O handling, error messages, checkpoints, unit testing, and more. The repository is exposed as a GitHub template so that the CI/CD implementation can be easily extended.

There are currently two templates: a circuit function template and an application function template. The circuit function template is built similarly to the IBM Circuit Function and the application function template illustrates how to structure a typical application workflow.


Next steps

Recommendations
Was this page helpful?
Report a bug or request content on GitHub.