Installation procedure for all main operating systems
PyFAI has been tested on various hardware: i386, x86_64, PPC64le, ARM. The main constrain may be the memory requirement: 2GB of memory is a minimal requirement to run the tests. The program may run with less but “MemoryError” are expected (appearing sometimes as segmentation faults). As a consequence, a 64-bits operating system with enough memory is strongly advised.
PyFAI is a Python library which relies on the scientific stack (numpy, scipy, matplotlib)
There are plenty of optional dependencies which will not prevent pyFAI from working by may impair performances or prevent tools from properly working:
In addition to the run dependencies, pyFAI needs a C compiler to build extensions.
C files are generated from cython source and distributed. The distributed version correspond to OpenMP version. Non-OpenMP version needs to be built from cython source code (especially on MacOSX). If you want to generate your own C files, make sure your local Cython version is sufficiently recent (>0.20).
python setup.py build
pip install . --upgrade
There are few specific options to setup.py:
PyFAI comes with a test suite to ensure all core functionalities are working as expected and numerical results are correct:
python setup.py build test
Nota: to run the test, an internet connection is needed as 200MB of test images need to be download. You may have to set the environment variable http_proxy and https_proxy according to the networking environment you are in. Specifically at ESRF, please phone the hotline at 24-24 to get those information.
PyFAI can use a certain number of environment variable to modify its default behavior: