Skip to content

Installing the package

Using pip recommended

The package is publicly available as a Python package and can be installed using pip.

pip install nlft-qsp

pip install nlft-qsp=="1.0.*"

Note

Python 3.10+ is required, and Python 3.11+ is recommended.

With git (editable mode)

It is also possible to clone the GitHub repo and then install the package in editable mode. This is particularly useful if it is necessary to modify the source code or to use features under development.

cd /your/target/directory # (1)!

git clone https://github.com/LorenzoLaneve/nlft-qsp .
pip install -e .

  1. This should be an empty directory which will hold the package, keep it in a safe place.

After installation

The package is available in Python by a standard import: 

from nlft_qsp import *

The package exposes the following components:

  • Classes for representing polynomials and expansions relevant for QSP
  • Classes to represent QSP protocols
  • Functions for QSP/QSVT solvers in several variants
  • Utility functions for plotting QSP functions

Command Line Interface

The package also provides a command line tool qspx. Check out the help section by running it on a terminal:

qspx --help

The following subcommands are available:

  • qspx solve [OPTIONS] TARGET
    Compute a QSP protocol for the given target polynomial

  • qspx approximate [OPTIONS] TARGET
    Compute a QSP protocol for a function given as a Python code

  • qspx make [OPTIONS] PHASE_FACTORS
    Compute the polynomial implemented by the given QSP protocol

  • qspx plot [OPTIONS] [TARGETS]...
    Plot the polynomials or functions using matplotlib

  • qspx complete [OPTIONS] TARGET
    Compute the complementary polynomial to the given target polynomial

The rest of this documentation also provides examples on how to use the qspx CLI.