Metadata-Version: 2.4
Name: wf-suite
Version: 1.0.8
Summary: APS Wavefront Analysis Tools
Author-email: Luca Rebuffi <lrebuffi@anl.gov>, Xianbo Shi <xshi@anl.gov>
Maintainer-email: "XSD-OPT Group @ APS-ANL" <lrebuffi@anl.gov>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/APS-XSD-OPT-Group/WFSuite
Project-URL: Download, https://github.com/APS-XSD-OPT-Group/WFSuite
Keywords: dictionary,glossary,synchrotron,simulation
Classifier: Development Status :: 5 - Production/Stable
Classifier: Natural Language :: English
Classifier: Environment :: Console
Classifier: Environment :: Plugins
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Intended Audience :: Science/Research
Description-Content-Type: text/markdown
Requires-Dist: aps-common-libraries>=1.0.49
Requires-Dist: PyQt6
Requires-Dist: PyWavelets
Requires-Dist: wofryImpl
Requires-Dist: wofrysrw
Requires-Dist: srwpy
Requires-Dist: cmasher
Requires-Dist: torch>=2.7.0

# WFSuite 1.0

WFSuite is a graphical and command-line toolkit for coded-mask-based X-ray wavefront sensing and phase reconstruction at synchrotron beamlines.


## Installation

We suggest creating a virtual environment with virtualenv or conda.
The program performs better with python 3.10+, and it has been tested up to python 3.13

To install it, run on a prompt of the target python environment: 

python -m pip install wf-suite

## Starting WFSuite

Open the GUI with:

python -m aps.wf_suite Launcher

The launcher provides access to:

· Absolute Phase

· Relative Metrology

· Wavefront Sensor (opens automatically)

Please refer to the [user manual](User-Manual.pdf) in the home directory of this repository for details. 

Example data and configuration files are available at https://anl.box.com/v/WFSuite-example-data
