Installing qpretrieve

qpretrieve is written in pure Python and supports Python version 3.10 and higher. qpretrieve depends on several other scientific Python packages, including:

numpy,

scipy, and

scikit-image (phase unwrapping using skimage.restoration.unwrap_phase()).

Base Package

To install qpretrieve, use one of the following methods (mandatory package dependencies will be installed automatically):

from PyPI:
pip install qpretrieve
from sources:
pip install -e .

Optional Dependencies

qpretrieve has two optional dependencies: PyFFTW and CuPy.

They can be installed individually or all at once:

pip install qpretrieve[FFTW]

pip install qpretrieve[FFTW,CUPY]

CuPy & CUDA Versions

CuPy works with CUDA devices. Running pip install qpretrieve[CUPY] will install cupy-cuda12x, which is compatible with CUDA version 12. If you have an older CUDA version, you will need to install cupy-cuda11x and run pip install cupy-cuda11x in your environment. See the CuPy website for details.