Usage

Requirement

To use CleanTiPy, first install the required packages :

  • numpy

  • matplotlib

  • scipy

  • pyfftw (optional, to speed up the discrete Fourier transforms (DFT) in DeconvolutionMethods.CleanT.find_max()).

  • simplespectral (uses pyfftw, scipy.fft or numpy.fft seamlessly)

  • joblib

Note

pyfftw requires FFTW3 to function. FFTW3 is available under two licenses, the free GPL and a non-free license that allows it to be used in proprietary program

Installation

This code is developed in Python 3.11 and therefore back-compatibility is not guaranteed.

Install the package with

pip install cleantipy

If installing from grithub repo: install the required packages with

pip install -r requirements.txt

Examples

Multiple examples are available examples folder on GitHub with some notebooks or scripts.

See examples notebook Examples.