Skip to content
🌊 Framework for studying fluid dynamics with numerical simulations using Python (publish-only mirror)
Python Other
  1. Python 99.5%
  2. Other 0.5%
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bench
doc
fluidsim
include
scripts
.appveyor.yml
.hgignore
.hgtags
.readthedocs.yml
.travis.yml
AUTHORS.rst
CHANGES.rst
HOWTO.txt
LICENSE.txt First commit for the new FluidDyn organization as "eggs". Mar 29, 2015
MANIFEST.in
Makefile
README.rst
bitbucket-pipelines.yml
environment.yml
postBuild Version bump and minor updates to README Nov 23, 2018
pylintrc
setup.cfg
setup.py
setup_build.py
setup_config.py
site.cfg.default
tox.ini
try_pyproject.toml

README.rst

FluidSim

Latest version Supported Python versions Documentation status Code coverage Travis CI status Chat room

Fluidsim is an extensible framework for studying fluid dynamics with numerical simulations using Python. Fluidsim is an object-oriented library to develop solvers (mainly using pseudo-spectral methods) by writing mainly Python code. The result is very efficient even compared to a pure Fortran or C++ code since the time-consuming tasks are performed by optimized compiled functions.

Documentation: https://fluidsim.readthedocs.io

Getting started

To try fluidsim without installation: Binder notebook

For a basic installation it should be sufficient to run:

pip install fluidsim --no-cache-dir [--user]

Add --user flag if you do not have permission to write in the directory of the python executable and you don't want to / can't setup a virtual environment or use pyenv or conda.

Installation

To take full advantage of fluidsim, consider installing the following (optional) dependencies and configurations before installing fluidsim. Click on the links to know more:

  1. OpenMPI or equivalent
  2. FFT libraries such as MPI-enabled FFTW (for 2D and 3D solvers) and P3DFFT, PFFT (for 3D solvers) either using a package manager or from source
  3. Install optional Python package dependencies
  4. A C++11 compiler and BLAS libraries and configure ~/.pythranrc to customize compilation of Pythran extensions
  5. Configure ~/.fluidfft-site.cfg to detect the FFT libraries and install fluidfft

Note: Detailed instructions to install the above dependencies using Anaconda / Miniconda or in a specific operating system such as Ubuntu, macOS etc. can be found here.

You can get the source code from Bitbucket or from the Python Package Index. The development mode is often useful if you intend to modify fluidsim . From the root directory:

python setup.py develop

Tests

After installing fluidsim run the tests to ensure everything works:

fluidsim-test
mpirun -np 2 fluidsim-test

How does it work?

Fluidsim is a HPC code. It is part of the wider project FluidDyn and its pseudospectral solvers rely on the library fluidfft to use very efficient FFT libraries. Fluidfft is written in C++, Cython and Python. Fluidfft and fluidsim take advantage of Pythran, an ahead-of-time compiler which produces very efficient binaries by compiling Python via C++11.

An advantage of a CFD code written mostly in Python is that, to run simulations and analyze the results, the users communicate (possibly interactively) together and with the machine with Python, which is nowadays among the best languages to do these tasks. Moreover, it is much simpler and faster than with pure Fortran or C++ codes to add any complicated analysis or to write a modified solver. Fluidsim can also be used to extend existing solvers with Python interfaces such as Basilisk.

We have created fluidsim to be easy and nice to use and to develop, efficient and robust.

Keywords and ambitions: fluid dynamics research with Python (>=3.6); modular, object-oriented, collaborative, tested and documented, free and open-source software.

License

FluidSim is distributed under the CeCILL License, a GPL compatible french license.

Metapapers and citations

If you use FluidSim to produce scientific articles, please cite our metapapers presenting the FluidDyn project, FluidFFT, and FluidSim:

@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}
}

@article{fluidfft,
doi = {10.5334/jors.238},
year = {2019},
publisher = {Ubiquity Press,  Ltd.},
volume = {7},
author = {Ashwin Vishnu Mohanan and Cyrille Bonamy and Pierre Augier},
title = {{FluidFFT}: Common {API} (C$\mathplus\mathplus$ and Python)
    for Fast Fourier Transform {HPC} Libraries},
journal = {Journal of Open Research Software}
}

@article{fluidsim,
doi = {10.5334/jors.239},
year = {2019},
publisher = {Ubiquity Press,  Ltd.},
volume = {7},
author = {Mohanan, Ashwin Vishnu and Bonamy, Cyrille and Linares, Miguel
    Calpe and Augier, Pierre},
title = {{FluidSim}: {Modular}, {Object}-{Oriented} {Python} {Package} for
    {High}-{Performance} {CFD} {Simulations}},
journal = {Journal of Open Research Software}
}
You can’t perform that action at this time.