guppyalgos documentation

guppy-algorithms is a library of reusable quantum-algorithm components built on guppy. It combines type-safe guppy primitives with Python builders for algorithms that start from classical data.

Any release before version 1.0.0 is experimental, and the API may change between releases. Pin the package version for reproducible work and review the changelog before upgrading.

Start with Getting started to compile a first program. The user guide introduces the library and its composition patterns; the notebooks provide runnable workflows, while the API reference documents individual components.

See the library in action: Block Encoding: From LCU to QSVT starts with a two-term LCU, builds a quantum walk, and applies QSVT. It then uses an eight-term Hamiltonian and introduces alias-sampling preparation with configurable QROM fanout.

Explore phase estimation: Phase estimation: one routine, different operators starts with one qubit, then estimates the same Hamiltonian’s energy using Trotterized evolution and qubitization. It includes measured results and a route to the advanced THC example.

Explore the building blocks: Arithmetic covers reversible register operations, and Measurement covers Pauli measurements and expectation estimation.

• Getting started
• User guide
  • Library structure and philosophy
  • Core concepts
  • Feature highlights
  • Testing quantum routines
  • Upcoming features

• API documentation
• Example notebooks