fluiddyn 0.2.0

framework for studying fluid dynamics.

FluidDyn is a framework for research and teaching in fluid dynamics. The Python package fluiddyn contains basic utilities (file io, figures, clusters, mpi, etc.). Most of the features of the FluidDyn project are actually implemented in other packages (in particular in fluidlab, fluidimage and fluidsim).

Key words and ambitions: fluid dynamics research with Python (2.7 or >= 3.4); modular, object-oriented, collaborative, tested and documented, free and open-source software.

License

FluidDyn is distributed under the CeCILL-B License, a BSD compatible french license.

Installation

It is recommended to install numpy before installing fluiddyn. The simplest way to install fluiddyn is by using pip:

pip install fluiddyn

You can get the source code from Bitbucket or from the Python Package Index.

The development mode is often useful. From the root directory, run:

python setup.py develop

Requirements

Minimum

• Python 2.7, >=3.4

• numpy

• matplotlib

• psutil

• future

• subprocess32 (for Python 2.7 only)

Full functionality

• h5py

• h5netcdf

• mpi4py

• scipy

• pyfftw (requires FFTW library)

• pillow

Optional

• OpenCV with Python bindings

• scikit-image

Tests

From the root directory:

make tests

Or, from the root directory or any of the “test” directories:

python -m unittest discover

History

FluidDyn is the evolution of two other codes previously developed by Pierre Augier (CNRS researcher at LEGI, Grenoble): Solveq2d (a numerical code to solve fluid equations in a periodic two-dimensional space with a pseudo-spectral method, developed at KTH, Stockholm) and FluidLab (a toolkit to do experiments, developed in the G. K. Batchelor Fluid Dynamics Laboratory at DAMTP, University of Cambridge).