SWaRP: Speckle Wavefront Reconstruction Package – User Manual

SWaRP (Speckle Wavefront Reconstruction Package ) is a numerical tool intended for wavefront recovery and reconstruction in both differential and absolute metrology modes, based on the X-ray Speckle Tracking (XST) principle. This pure Python software package consists of two main scripts (detectorDistortion.py and waveFront.py) and several libraries (func.py – containing the main functions of the code, EdfFile.py – dedicated to handling the EDF file format, norm_xcorr.py – computes subset displacements using cross-correlation in the real-space, g2s.py – performs grad2surf integration). Currently, the code is designed to be run directly from a terminal without a graphical user interface.