Installation and advice

Dependencies and useful packages

  • Python 2.7 or >3.4 (unless you have a good reason, use python >= 3.6!)
  • fftw
  • numpy, scipy, matplotlib, h5py
  • fluiddyn
  • pyfftw (simplest way to compute fft quite efficiently)
  • pythran (to be fast)
  • h5netcdf (only if you need netcdf files)
  • scikit-image (only for preprocessing of images)
  • PyQt5 (only for GUI)
  • ipython (important to play interactively with parameters, images and results)
  • jupyter (to try the tutorials yourself)

The simplest way to get a good environment for fluidimage is by using conda (with anaconda or miniconda). If you use conda, install the main packages with:

conda install numpy scipy matplotlib h5py scikit-image pyqt

conda install ipython jupyter

and the other packages with pip:

pip install pyfftw pythran h5netcdf colorlog fluiddyn

Installation with pip

FluidImage can also be installed from the Python Package Index:

pip install fluidimage --pre

The --pre option of pip allows the installation of a pre-release version.

However, the project is in an active phase of development so it can be better to use the last version (from the mercurial repository hosted on Bitbucket).