A library of reusable primitives for composing abstract quantum algorithms, written in guppy.
The guppyalgos package includes quantum arithmetic, state preparation, QROM,
block encoding, Hamiltonian simulation, and phase estimation. It's reusable
components let you choose circuit implementations when assembling an algorithm.
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.
Requires Python 3.12 or newer and uv. Install from a source checkout:
git clone https://github.com/Quantinuum/guppyalgos.git
cd guppyalgos
uv syncExplore the example notebooks and the getting-started guide for usage and compilation examples.
See documentation for user guide.
See CONTRIBUTING.md for development setup, checks, and our
gh stack workflow for stacked pull requests.
If you use this library in research, please cite it using CITATION.cff and include the version or commit you used.
The guppyalgos package is licensed under the Apache License 2.0.
Bundled material with a separate license retains its own license terms.