Skip to main content

Educational utilities and examples for Quantum Singular Value Transformation (QSVT) using PennyLane.

Project description

Quantum Singular Value Transformation (QSVT)

PyPI Version Python Versions License Tests Sponsor

Lightweight tools for experimenting with Quantum Singular Value Transformation (QSVT) using PennyLane.

PyPI package: https://pypi.org/project/qsvt-pennylane/

This repository combines:

  • a notebook-first introduction to QSVT
  • a reusable Python package for bounded polynomial transforms

The focus is on spectral intuition:

how bounded polynomials transform singular values or eigenvalues via block encodings.


Table of Contents


Installation

Install from PyPI:

pip install qsvt-pennylane

Install from source:

git clone https://github.com/SidRichardsQuantum/Quantum_Singular_Value_Transformation.git
cd Quantum_Singular_Value_Transformation

pip install -e .

Requirements:

  • Python ≥ 3.10
  • PennyLane ≥ 0.36
  • NumPy ≥ 1.23
  • Matplotlib ≥ 3.7

Quick example

Scalar polynomial transform:

from qsvt.qsvt import qsvt_scalar_output

qsvt_scalar_output(
    x=0.5,
    poly=[0,0,1],  ## x²
    encoding_wires=[0],
)

Diagonal transform:

from qsvt.qsvt import qsvt_diagonal_transform

qsvt_diagonal_transform(
    values=[1.0, 0.7, 0.3, 0.1],
    poly=[0,0,1],
    encoding_wires=[0,1,2],
)

Design a bounded sign polynomial:

from qsvt.design import design_sign_polynomial

coeffs = design_sign_polynomial(
    gamma=0.25,
    degree=13,
)

Package overview

The package provides small, composable utilities for constructing and applying bounded polynomial transforms.

Polynomial utilities

qsvt.polynomials

  • Chebyshev polynomials
  • polynomial degree and parity
  • boundedness checks
  • coefficient normalisation

Polynomial approximation

qsvt.approximation

  • Chebyshev fitting
  • approximation error metrics
  • polynomial evaluation helpers

Polynomial templates

qsvt.templates

Ready-to-use bounded polynomial families:

  • inverse-like polynomials
  • sign approximations
  • soft threshold filters
  • sqrt approximations
  • exponential weighting functions
  • approximation-quality reports

Useful for quick experiments.


Polynomial design

qsvt.design

Task-oriented polynomial builders:

  • inverse-like transforms
  • sign polynomials
  • projector polynomials
  • sqrt approximations
  • power-law transforms
  • smooth spectral filters
  • approximation-quality reports

Designed for reusable QSVT workflows.


Matrix helpers

qsvt.matrices

Small Hermitian test matrices:

  • diagonal matrices
  • rotated diagonal matrices
  • involutory matrices

Classical spectral reference

qsvt.spectral

Reference matrix-function utilities:

  • matrix powers
  • matrix square roots
  • matrix sign
  • spectral projectors

Useful for validating polynomial transforms.


QSVT simulation utilities

qsvt.qsvt

Thin wrappers around PennyLane QSVT:

  • scalar QSVT transforms
  • diagonal transforms
  • block extraction
  • classical vs QSVT comparisons

Documentation

Full documentation:

Current release: 0.1.5


Notebooks

The notebooks provide a guided introduction to QSVT as polynomial functional calculus.

  1. scalar intuition
  2. singular value filtering
  3. QSP polynomials
  4. exact linear solvers
  5. approximate inverse behaviour
  6. polynomial design and approximation
  7. matrix powers and roots
  8. sign function and projectors
  9. reusable polynomial workflows

The examples emphasise:

  • bounded polynomial structure
  • spectral interpretation
  • simple matrices
  • reproducible results

CLI

After installation:

qsvt scalar --x 0.5 --poly "0,0,1"

qsvt diag \
  --values "1.0,0.7,0.3,0.1" \
  --poly "0,0,1" \
  --wires 3

qsvt cheb --degree 3 --x 0.5

qsvt design-report --kind sign --gamma 0.2 --degree 13

qsvt template-report --kind inverse --degree 7 --mu 0.3

The report commands print the same JSON diagnostics used by the Python helpers, including fit error and boundedness information.


Scope and philosophy

This repository is intentionally:

  • educational
  • explicit
  • simulator-friendly
  • polynomial-focused

The goal is to make QSVT easier to experiment with and understand.

Topics intentionally outside scope:

  • circuit optimisation
  • resource estimation
  • fault tolerance
  • amplitude amplification
  • state preparation methods

The emphasis is understanding how polynomial transforms act on spectra.


Support development

If this repository is useful for research, learning, or experimentation, you can support continued development via GitHub Sponsors:

https://github.com/sponsors/SidRichardsQuantum

Sponsorship supports continued work on open-source implementations of quantum algorithms, including polynomial-based quantum signal processing, spectral transforms, and reproducible research tooling.

Support helps maintain accessible reference implementations for experimenting with QSVT, QSP, and matrix functional calculus workflows.


Author

Sid Richards

GitHub: https://github.com/SidRichardsQuantum

LinkedIn: https://www.linkedin.com/in/sid-richards-21374b30b/


License

MIT License — see LICENSE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qsvt_pennylane-0.1.5.tar.gz (31.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qsvt_pennylane-0.1.5-py3-none-any.whl (30.9 kB view details)

Uploaded Python 3

File details

Details for the file qsvt_pennylane-0.1.5.tar.gz.

File metadata

  • Download URL: qsvt_pennylane-0.1.5.tar.gz
  • Upload date:
  • Size: 31.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for qsvt_pennylane-0.1.5.tar.gz
Algorithm Hash digest
SHA256 cc9269fcfa3d143529b6d7460c85b48141f2c086ea4e3578163b500e5d417b37
MD5 796f5314442ce9e9023eb474d9bab3c4
BLAKE2b-256 093ae725e75b475dc1bbb0dda371094690cf54897e48e9b00c0b4424dbf9fb50

See more details on using hashes here.

Provenance

The following attestation bundles were made for qsvt_pennylane-0.1.5.tar.gz:

Publisher: publish.yml on SidRichardsQuantum/Quantum_Singular_Value_Transformation

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qsvt_pennylane-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: qsvt_pennylane-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 30.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for qsvt_pennylane-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 cb38a5fd122cf1af45181e2072fff9e0442f7940b30f7d282ff176d8bd12a2a7
MD5 08134e71cb4396a994f2afa359df631f
BLAKE2b-256 48c7cf0e68c85eda729da65f7f63594af7b475e821e146470fa674d0c2668df0

See more details on using hashes here.

Provenance

The following attestation bundles were made for qsvt_pennylane-0.1.5-py3-none-any.whl:

Publisher: publish.yml on SidRichardsQuantum/Quantum_Singular_Value_Transformation

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page