Installation

Dependencies

  • Minimum : Python (>=3.6), numpy, matplotlib, h5py, h5netcdf, psutil

  • Full functionality: pillow, imageio, mpi4py, scipy, pyfftw (requires FFTW library)

  • Optional: OpenCV with Python bindings, scikit-image

It is recommended to install NumPy and Matplotlib before installing FluidDyn.

FluidDyn also used some other packages for some particular tasks, as in particular Scipy. Since it can be difficult to install them for some small hardware, they are not considered as real dependencies. However, be prepared to get some ImportError :-)

We present how to install the requirements in this page:

Basic installation

FluidDyn can be installed from the Python Package Index by the command:

pip install fluiddyn

Or, to also install all optional dependencies:

pip install fluiddyn[full]

Install in development mode

Get the source by cloning the repository (as explained in Advice for FluidDyn developers):

hg clone https://bitbucket.org/fluiddyn/fluiddyn

or by manually downloading the package from the Bitbucket page or from the PyPI page.

The development mode is often very convenient. From the root directory of the project, run:

cd fluiddyn
pip install -e .

After the installation, it is a good practice to run the unit tests by running pytest from the root directory or from any of the “test” directories. To install the test dependencies:

pip install -e .[test]