pyFAI

Summary

Source: https://github.com/silx-kit/pyFAI

License: https://github.com/silx-kit/pyFAI/blob/master/copyright

Path: either in system PATH or as part of conda installations

Documentation: http://pythonhosted.org/pyFAI/

Citation: see https://github.com/silx-kit/pyFAI

pyFAI is an azimuthal integration library that tries to be fast (as fast as C and even more using OpenCL and GPU). It is based on histogramming of the 2theta/Q positions of each (center of) pixel weighted by the intensity of each pixel, but parallel version uses a SparseMatrix-DenseVector multiplication. Neighboring output bins get also a contribution of pixels next to the border thanks to pixel splitting.

Using pyFAI

There are two pyFAI installations available on Maxwell. We recommend the mamba/conda based installation.

Conda installation

pyFAI is also available as a conda/mamba-based installations, and jupyter kernel.

module load maxwell

module avail pyFAI
    pyFAI/0.20.0 pyFAI/0.21.3 pyFAI/2023.1

module load pyFAI
python3 -c 'import pyFAI;print(pyFAI.version_info[0:3])'
   (2023, 1, 0)

# --------------------------------------------------------------------------------- #
# loading the pyFAI module is roughly equivalent to loading the conda environment:

module load maxwell conda/3.9
. mamba-init
mamba activate pyFAI

python3 -c 'import pyFAI;print(pyFAI.version_info[0:3])'
   (2023, 1, 0)

mamba deactivate  # better open a new shell/terminal/tab

# ---------------------------------------------------------------------------------- #

# package information
xwhich pyFAI-calib

 Local path for pyFAI-calib:
    /usr/bin/pyFAI-calib 

 Provided by module(s)
   ... module load maxwell pyFAI; which pyFAI-calib: /software/anaconda3/5.2/envs/pyFAI/bin/pyFAI-calib
   ... [and several others omitted here]

 Documentation: https://confluence.desy.de/display/IS/pyFAI
 URL:           https://pypi.python.org/pypi/pyFAI/
 Manual:        http://pythonhosted.org/pyFAI/
 License:       GPL