Welcome to qsppack’s documentation!

qsppack is a Python package for Quantum Signal Processing optimization and analysis. This package is based on a MATLAB package by the same name. The MATLAB code can be found at https://github.com/qsppack/QSPPACK, with an earlier version of the tutorials and examples at https://qsppack.gitbook.io/qsppack/ (not actively maintained).

Installation

You can install qsppack using pip:

pip install qsppack

Or install from source:

git clone https://github.com/qsppack/pyqsppack.git
cd pyqsppack
pip install -e .

For development and testing, install with test dependencies:

pip install -e ".[test]"

Contents

Contents:

• Solver Module
  • solve()
• Objective Module
  • obj_sym()
  • grad_sym()
  • grad_sym_real()
• Optimizers Module
  • lbfgs()
  • coordinate_minimization()
  • newton()
  • nlft()
• Utilities Module
  • get_unitary()
  • reduced_to_full()
  • chebyshev_to_func()
  • cvx_poly_coef()
  • F()
  • F_Jacobian()
• Nonlinear Fourier Analysis Module
  • b_from_cheb()
  • weiss()
  • inverse_nonlinear_FFT()
  • forward_nlft()
  • forward_nonlinear_FFT()
• Examples
  • Quantum Linear Systems Problem
  • Negative Power Functions
  • Hamiltonian Simulation
  • Quantum Gaussian Filter
  • Singular Value Threshold Projector
  • Singular Vector Transformation
  • Uniform Singular Value Amplification
  • Gaussian State
  • Kaiser Window State
  • Gibbs State

• Index