Skip to content
Snippets Groups Projects
user avatar
Ashwin Vishnu authored
c366285e
History
Name Last commit Last update
doc
fluidsim
include
scripts
.hgignore
.hgtags
CHANGES.rst
HOWTO.txt
LICENSE.txt
MANIFEST.in
Makefile
README.rst
pylintrc
setup.cfg
setup.py

===========
GeoFluidDyn
===========

*Framework for studying fluid dynamics by numerical simulation.*

`Package Documentation `__

FluidSim is the numerically oriented package of the `FluidDyn project
`__. The project is still in a
testing stage so it is still pretty unstable and many of its planned
features have not yet been implemented.

It has first been developed by `Pierre Augier
`_ (CNRS
researcher at `LEGI `_, Grenoble) at
KTH (Stockholm) as a numerical code to solve fluid equations in a
periodic two-dimensional space with pseudo-spectral methods.

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

License
-------

FluidDyn is distributed under the CeCILL_ License, a GPL compatible
french license.

.. _CeCILL: http://www.cecill.info/index.en.html

Installation
------------

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

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

python setup.py develop

Tests
-----

From the root directory::

make tests
make tests_mpi

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

python -m unittest discover