# Fast Azimuthal Integration using Python

PyFAI A Python libary for high performance azimuthal integration which can use on GPU, which was presented at EuroScipy 2014: the video is online as well as the proceedings.

This document starts with a general descriptions of the pyFAI library in the first chapter. This first chapter contains an introduction to pyFAI, what it is, what it aims at and how it works (for scientists). Especially, geometry, calibration, azimuthal integration algorithms are described and pixel splitting schemes are explained.

Follows cookbook, tutorials on how to use pyFAI scripts, then the manual pages of all scripts. Those are programs to be launched at the command line allowing the treatment of a diffraction experiment without knowing anything about Python.

The design of the programming interface is then exposed before a comprehensive description of most modules contained in pyFAI. Some minor submodules as well as the documentation of the Cython sub-modules are not included for concision purposes. The last chapter is an appendix giving some figures about the project and its management.

Installation procedures for Windows, MacOSX and Linux operating systems are then described. Finally other programs/projects relying on pyFAI are presented and the project is summarized from a developer’s point of view.

- General introduction to PyFAI
  - Python Fast Azimuthal Integration
  - Introduction
  - Experiment description
  - Regrouping mechanism
  - Related Work
  - Conclusion
- Cookbook recipes
  - Calibration of a diffraction setup
  - Azimuthal integration using the graphical user interface
- pyFAI scripts manual
  - Preprocessing tool: pyFAI-average
  - Mask generation tool: drawMask_pymca
  - Preprocessing tool: detector2nexus
  - Calibration tool: pyFAI-calib
  - Calibration tool: pyFAI-recalib
  - Calibration tool: check_calib
  - Calibration tool: MX-calibrate
  - Integration tool: pyFAI-integrate
  - Integration tool: diff_tomo
  - Integration tool: pyFAI-saxs
  - Integration tool: pyFAI-waxs
- Design of the Python Fast Azimuthal Integration library
  - Design of the Python Fast Azimuthal Integrator
- pyFAI API
  - `pyFAI` Package
  - `azimuthalIntegrator` Module
  - `integrate_widget` Module
  - `geometry` Module
  - `geometryRefinement` Module
  - `detectors` Module
  - `spline` Module
  - `opencl` Module
  - `ocl_azim` Module
  - `ocl_azim_lut` Module
  - `ocl_azim_csr` Module
  - `ocl_azim_csr_dis` Module
  - `worker` Module
  - `io` Module
  - `calibration` Module
  - `peak_picker` Module
  - `massif` Module
  - `blob_detection` Module
  - `calibrant` Module
  - `distortion` Module
  - `units` Module
  - `utils` Module
  - `gui_utils` Module
- Installation of Python Fast Azimuthal Integration library
  - Abstract
  - Hardware requirement
  - Dependencies
  - Build dependencies:
  - Building procedure
  - Test suites
  - Environment variables
  - References:
- PyFAI Ecosystem
  - Software pyFAI is relying on
  - Program using pyFAI as a library
- Programming language
- Repository:
- Getting help
- Run dependencies
- Build dependencies:
- Building procedure
  - As most of the python projects:
- Test suites
  - To run the test an internet connection is needed as 200MB of test images will be downloaded.
- List of contributors in code
- List of other contributors (ideas or code)
- List of supporters
- Changelog of Versions
  - 0.1: 05/2011
  - 0.2: 07/2011
  - 0.3: 11/2011
  - 0.4: 06/2012
  - 0.5: 06/2012
  - 0.6: 07/2012
  - 0.7: 07/2012
  - 0.7.2: 08/2012
  - 0.8: 10/2012
  - 0.9: 10/2013
  - 0.9.2: (01/2014)
  - 0.9.3: 02/2014
  - 0.9.4: 06/2014
  - 0.10.0: 10/2014
  - 0.10.1: 10/2014
  - 0.10.2: 11/2014
  - 0.10.3: 03/2015
  - 0.11.0: 07/2015

# Indices and tables

- Index
- Module Index
- Search Page