Metadata-Version: 2.1
Name: fluiddyn
Version: 0.3.1
Summary: Framework for studying fluid dynamics.
Home-page: https://bitbucket.org/fluiddyn/fluiddyn
Author: Pierre Augier
Author-email: pierre.augier@legi.cnrs.fr
License: CeCILL-B License
Keywords: Fluid dynamics,research
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: h5py
Requires-Dist: h5netcdf
Requires-Dist: psutil (>=5.2.1)
Requires-Dist: cached-property ; python_version < "3.8"
Requires-Dist: distro ; python_version >= "3.8"
Provides-Extra: dev
Requires-Dist: sphinx ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
Requires-Dist: numpydoc ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: ipython ; extra == 'dev'
Requires-Dist: ipdb ; extra == 'dev'
Requires-Dist: pyfftw (>=0.10.4) ; extra == 'dev'
Requires-Dist: mpi4py ; extra == 'dev'
Provides-Extra: doc
Requires-Dist: sphinx ; extra == 'doc'
Requires-Dist: sphinx-rtd-theme ; extra == 'doc'
Requires-Dist: numpydoc ; extra == 'doc'
Provides-Extra: fft
Requires-Dist: pyfftw (>=0.10.4) ; extra == 'fft'
Provides-Extra: mpi
Requires-Dist: mpi4py ; extra == 'mpi'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: ipython ; extra == 'test'
Requires-Dist: ipdb ; extra == 'test'
Requires-Dist: pyfftw (>=0.10.4) ; extra == 'test'

:alt: Travis CI status

.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/8tipjogdw679ucsh?svg=true
   :target: https://ci.appveyor.com/project/fluiddyn/fluiddyn
   :alt: AppVeyor status

.. |binder| image:: https://mybinder.org/badge_logo.svg
   :target: https://mybinder.org/v2/gh/fluiddyn/fluiddyn/master?urlpath=lab/tree/doc/ipynb
   :alt: Binder notebook

FluidDyn project is an ecosystem of packages for research and teaching in fluid
dynamics. The Python package fluiddyn contains:

* **basic utilities to manage**: File I/O for some esoteric formats,
  publication quality figures, job submission on clusters, MPI
* **powerful classes to handle**: parameters, arrays, series of files
* **simplified interfaces to calculate**: FFT, spherical harmonics

and much more. It is used as a library in `the other specialized packages of
the FluidDyn project <https://bitbucket.org/fluiddyn>`_ (in particular in
`fluidfft <http://fluidfft.readthedocs.io>`_, `fluidsim
<http://fluidsim.readthedocs.io>`_, `fluidlab
<http://fluidlab.readthedocs.io>`_ and `fluidimage
<http://fluidimage.readthedocs.io>`_).

**Documentation**: https://fluiddyn.readthedocs.io

Getting started
---------------
To try fluiddyn without installation: |binder|

Installation
------------
The simplest way to install fluiddyn is by using pip::

  pip install fluiddyn [--user]

Add ``--user`` flag if you are installing without setting up a virtual
environment.

You can also get the source code from `Bitbucket
<https://bitbucket.org/fluiddyn/fluiddyn>`_ or from `the Python Package Index
<https://pypi.python.org/pypi/fluiddyn/>`_.  It is recommended to `install
numpy <http://scipy.org/install.html>`_ before installing fluiddyn.  The
development mode is often useful if you intend to modify fluiddyn. From the
root directory::

  python setup.py develop


Requirements
------------

+------------------------+-------------------------------------------------------------------------------+
| **Minimum**            | Python (>=3.6), ``numpy matplotlib h5py psutil``                              |
+------------------------+-------------------------------------------------------------------------------+
| **Full functionality** | ``h5py h5netcdf pillow imageio mpi4py scipy pyfftw`` (requires FFTW library), |
|                        | SHTns                                                                         |
+------------------------+-------------------------------------------------------------------------------+
| **Optional**           | OpenCV with Python bindings, ``scikit-image``                                 |
+------------------------+-------------------------------------------------------------------------------+

**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
<https://fluiddyn.readthedocs.io/en/latest/get_good_Python_env.html>`__.

Tests
-----

From the root directory::

  make tests

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

  python -m unittest discover

Citing
------

If you need to cite a FluidDyn paper, feel free to use:
https://arxiv.org/abs/1807.09224

History
-------

The FluidDyn project started in 2015 as the evolution of two packages
previously developed by `Pierre Augier
<http://www.legi.grenoble-inp.fr/people/Pierre.Augier/>`_ (CNRS researcher at
`LEGI <http://www.legi.grenoble-inp.fr>`_, 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).

*Keywords and ambitions*: fluid dynamics research with Python (>= 3.6),
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.

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


