FluidDyn documentation

The FluidDyn project aims at promoting the use of open-source Python software in research in fluid dynamics. The project provides some Python packages specialized for different tasks, in particular

  • transonic, to make your Python code fly at transonic speeds!

  • fluidfft for 2D and 3D Fast Fourier Transforms,

  • fluidsim for numerical simulations,

  • fluidlab for laboratory experiments,

  • fluidimage for processing of images of fluid,

  • fluidsht for Spherical Harmonic Transforms.

This documentation presents the FluidDyn project and the package of the same name, which is the base package on which the other packages depend on. For the specific documentations of these specialized packages, follow the links above.

The FluidDyn project

Metapaper and citation

If you use any of the FluidDyn packages to produce scientific articles, please cite our metapaper presenting the FluidDyn project and the fluiddyn package:

@article{fluiddyn,
doi = {10.5334/jors.237},
year = {2019},
publisher = {Ubiquity Press,  Ltd.},
volume = {7},
author = {Pierre Augier and Ashwin Vishnu Mohanan and Cyrille Bonamy},
title = {{FluidDyn}: A Python Open-Source Framework for Research and Teaching in Fluid Dynamics
    by Simulations,  Experiments and Data Processing},
journal = {Journal of Open Research Software}
}

Modules Reference

In order to discover FluidDyn, the best is to see how it is structured. Here is a list of the first-level packages. If you are looking for a particular feature, you can also use the “Quick search” tool in this page.

fluiddyn.io

Input/output streams

fluiddyn.util

Utilities

fluiddyn.clusters

Clusters

fluiddyn.output

Scientific output toolkit

fluiddyn.calcul

Numerical computation

Fluiddyn also provides a small package for documentation:

fluiddoc

Utilities to build documentations with sphinx

Indices and tables