Installation procedure on Linux

We cover first Debian-like distribution, then a generic recipie is given.

Installation procedure on Debian/Ubuntu

PyFAI has been designed and originally developed on Ubuntu 10.04 and debian6. Now, the pyFAI library is included into debian7, 8 and any recent Ubuntu and Mint distribution. To install the package provided by the distribution, use:

sudo apt-get install pyfai

Debian7 and Ubuntu 12.04

To build a more recent version, pyFAI provides you a small scripts which builds a debian package and installs it. It relies on stdeb and provides a single package with everything inside. You will be prompted for your password to gain root access in order to be able to install the freshly built package.

sudo apt-get install python-stdeb cython python-fabio
./build-deb.sh

Debian8 and newer

Thanks to the work of Frédéric-Emmanuel Picca, the debian package of pyFAI provides a pretty good template.

sudo apt-get install cython cython-dbg cython3 cython3-dbg debhelper dh-python \
python-all-dev python-all-dbg python-fabio python-fabio-dbg python-fftw python-h5py \
python-lxml python-lxml-dbg python-matplotlib python-matplotlib-dbg python-numpy\
python-numpy-dbg python-qt4 python-qt4-dbg python-scipy python-scipy-dbg python-sphinx \
python-sphinxcontrib.programoutput python-tk python-tk-dbg python3-all-dev python3-all-dbg \
python3-fabio python3-fabio-dbg python3-lxml python3-lxml-dbg python3-matplotlib \
python3-matplotlib-dbg python3-numpy python3-numpy-dbg python3-pyqt4 python3-pyqt4-dbg \
python3-scipy python3-scipy-dbg python3-sphinx python3-sphinxcontrib.programoutput \
python3-tk python3-tk-dbg

./build-debian-full.sh

The first line is really long and defines all the dependence tree for building debian package, including debug and documentation. The build procedure last for a few minutes and you will be prompted for your password in order to install the freshly built packages. The deb-*files, available in the *package directory are backports of the debian9 version for your local install.

Installation procedure on other linux distibution

If your distribution does not provide you pyFAI packages, using the PIP way is advised, via wheels packages. First install pip and wheel:

Then you can install pyFAI the usual way:

python setup.py build test
sudo pip install . --upgrade

Nota: The usage of “python setup.py install” is now deprecated. It causes much more trouble as there is no installed file tracking, hence no way to de-install properly a package.