| Name | fluiddyn JSON |
| Version |
0.8.0
JSON |
| download |
| home_page | None |
| Summary | Framework for studying fluid dynamics. |
| upload_time | 2024-12-20 11:49:53 |
| maintainer | None |
| docs_url | https://pythonhosted.org/fluiddyn/ |
| author | None |
| requires_python | >=3.10 |
| license | CeCILL-B License |
| keywords |
fluid dynamics
research
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
======
|logo|
======
|release| |pyversions| |docs| |coverage| |heptapod_ci| |github_actions|
.. |logo| image:: https://foss.heptapod.net/fluiddyn/fluiddyn/raw/branch/default/doc/logo.svg
:alt: FluidDyn project and fluiddyn package
.. |release| image:: https://img.shields.io/pypi/v/fluiddyn.svg
:target: https://pypi.python.org/pypi/fluiddyn/
:alt: Latest version
.. |pyversions| image:: https://img.shields.io/pypi/pyversions/fluiddyn.svg
:alt: Supported Python versions
.. |docs| image:: https://readthedocs.org/projects/fluiddyn/badge/?version=latest
:target: http://fluiddyn.readthedocs.org
:alt: Documentation status
.. |coverage| image:: https://codecov.io/gh/fluiddyn/fluiddyn/branch/branch%2Fdefault/graph/badge.svg
:target: https://codecov.io/gh/fluiddyn/fluiddyn/branch/branch%2Fdefault
:alt: Code coverage
.. |heptapod_ci| image:: https://foss.heptapod.net/fluiddyn/fluiddyn/badges/branch/default/pipeline.svg
:target: https://foss.heptapod.net/fluiddyn/fluiddyn/-/pipelines
:alt: Heptapod CI
.. |github_actions| image:: https://github.com/fluiddyn/fluidsim/actions/workflows/ci-linux.yml/badge.svg?branch=branch/default
:target: https://github.com/fluiddyn/fluiddyn/actions/
:alt: Github Actions
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://foss.heptapod.net/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**: `Read the Docs <https://fluiddyn.readthedocs.io>`_, `Heptapod Pages <https://fluiddyn.pages.heptapod.net/fluiddyn>`_
Installation
------------
The simplest way to install fluiddyn is by using pip::
pip install fluiddyn
Requirements
------------
+------------------------+-------------------------------------------------------------------------------+
| **Minimum** | Python (>=3.9), ``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
-----
With an editable installation, you can run the tests with::
pytest
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
<https://openresearchsoftware.metajnl.com/articles/10.5334/jors.237/>`_:
.. code ::
@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}
}
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
Raw data
{
"_id": null,
"home_page": null,
"name": "fluiddyn",
"maintainer": null,
"docs_url": "https://pythonhosted.org/fluiddyn/",
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "Fluid dynamics, research",
"author": null,
"author_email": "Pierre Augier <pierre.augier@legi.cnrs.fr>",
"download_url": "https://files.pythonhosted.org/packages/53/f2/edc673546ee42e3fce14490ce38798a81eef46438db09fa9136e9f172ca3/fluiddyn-0.8.0.tar.gz",
"platform": null,
"description": "======\n|logo|\n======\n\n|release| |pyversions| |docs| |coverage| |heptapod_ci| |github_actions|\n\n.. |logo| image:: https://foss.heptapod.net/fluiddyn/fluiddyn/raw/branch/default/doc/logo.svg\n :alt: FluidDyn project and fluiddyn package\n\n.. |release| image:: https://img.shields.io/pypi/v/fluiddyn.svg\n :target: https://pypi.python.org/pypi/fluiddyn/\n :alt: Latest version\n\n.. |pyversions| image:: https://img.shields.io/pypi/pyversions/fluiddyn.svg\n :alt: Supported Python versions\n\n.. |docs| image:: https://readthedocs.org/projects/fluiddyn/badge/?version=latest\n :target: http://fluiddyn.readthedocs.org\n :alt: Documentation status\n\n.. |coverage| image:: https://codecov.io/gh/fluiddyn/fluiddyn/branch/branch%2Fdefault/graph/badge.svg\n :target: https://codecov.io/gh/fluiddyn/fluiddyn/branch/branch%2Fdefault\n :alt: Code coverage\n\n.. |heptapod_ci| image:: https://foss.heptapod.net/fluiddyn/fluiddyn/badges/branch/default/pipeline.svg\n :target: https://foss.heptapod.net/fluiddyn/fluiddyn/-/pipelines\n :alt: Heptapod CI\n\n.. |github_actions| image:: https://github.com/fluiddyn/fluidsim/actions/workflows/ci-linux.yml/badge.svg?branch=branch/default\n :target: https://github.com/fluiddyn/fluiddyn/actions/\n :alt: Github Actions\n\nFluidDyn project is an ecosystem of packages for research and teaching in fluid\ndynamics. The Python package fluiddyn contains:\n\n* **basic utilities to manage**: File I/O for some esoteric formats,\n publication quality figures, job submission on clusters, MPI\n* **powerful classes to handle**: parameters, arrays, series of files\n* **simplified interfaces to calculate**: FFT, spherical harmonics\n\nand much more. It is used as a library in `the other specialized packages of\nthe FluidDyn project <https://foss.heptapod.net/fluiddyn>`_ (in particular in\n`fluidfft <http://fluidfft.readthedocs.io>`_, `fluidsim\n<http://fluidsim.readthedocs.io>`_, `fluidlab\n<http://fluidlab.readthedocs.io>`_ and `fluidimage\n<http://fluidimage.readthedocs.io>`_).\n\n**Documentation**: `Read the Docs <https://fluiddyn.readthedocs.io>`_, `Heptapod Pages <https://fluiddyn.pages.heptapod.net/fluiddyn>`_\n\nInstallation\n------------\nThe simplest way to install fluiddyn is by using pip::\n\n pip install fluiddyn\n\nRequirements\n------------\n\n+------------------------+-------------------------------------------------------------------------------+\n| **Minimum** | Python (>=3.9), ``numpy matplotlib h5py psutil`` |\n+------------------------+-------------------------------------------------------------------------------+\n| **Full functionality** | ``h5py h5netcdf pillow imageio mpi4py scipy pyfftw`` (requires FFTW library), |\n| | SHTns |\n+------------------------+-------------------------------------------------------------------------------+\n| **Optional** | OpenCV with Python bindings, ``scikit-image`` |\n+------------------------+-------------------------------------------------------------------------------+\n\n**Note**: Detailed instructions to install the above dependencies using\nAnaconda / Miniconda or in a specific operating system such as Ubuntu, macOS\netc. can be found `here\n<https://fluiddyn.readthedocs.io/en/latest/get_good_Python_env.html>`__.\n\nTests\n-----\n\nWith an editable installation, you can run the tests with::\n\n pytest\n\n\nMetapaper and citation\n----------------------\n\nIf you use any of the FluidDyn packages to produce scientific articles, please\ncite `our metapaper presenting the FluidDyn project and the fluiddyn package\n<https://openresearchsoftware.metajnl.com/articles/10.5334/jors.237/>`_:\n\n.. code ::\n\n @article{fluiddyn,\n doi = {10.5334/jors.237},\n year = {2019},\n publisher = {Ubiquity Press, Ltd.},\n volume = {7},\n author = {Pierre Augier and Ashwin Vishnu Mohanan and Cyrille Bonamy},\n title = {{FluidDyn}: A Python Open-Source Framework for Research and Teaching in Fluid Dynamics\n by Simulations, Experiments and Data Processing},\n journal = {Journal of Open Research Software}\n }\n\nHistory\n-------\n\nThe FluidDyn project started in 2015 as the evolution of two packages\npreviously developed by `Pierre Augier\n<http://www.legi.grenoble-inp.fr/people/Pierre.Augier/>`_ (CNRS researcher at\n`LEGI <http://www.legi.grenoble-inp.fr>`_, Grenoble): solveq2d (a numerical\ncode to solve fluid equations in a periodic two-dimensional space with a\npseudo-spectral method, developed at KTH, Stockholm) and fluidlab (a toolkit to\ndo experiments, developed in the G. K. Batchelor Fluid Dynamics Laboratory at\nDAMTP, University of Cambridge).\n\n*Keywords and ambitions*: fluid dynamics research with Python (>= 3.6),\nmodular, object-oriented, collaborative, tested and documented, free and\nopen-source software.\n\nLicense\n-------\n\nFluidDyn is distributed under the CeCILL-B_ License, a BSD compatible\nfrench license.\n\n.. _CeCILL-B: http://www.cecill.info/index.en.html\n",
"bugtrack_url": null,
"license": "CeCILL-B License",
"summary": "Framework for studying fluid dynamics.",
"version": "0.8.0",
"project_urls": {
"conda-forge": "https://github.com/conda-forge/fluiddyn-feedstock",
"documentation": "https://fluiddyn.readthedocs.io",
"homepage": "https://foss.heptapod.net/fluiddyn/fluiddyn",
"twitter": "https://twitter.com/pyfluiddyn"
},
"split_keywords": [
"fluid dynamics",
" research"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c9960359959960f4f7d8fbfafc763ee465e4544e893201d97537830dbc6a7630",
"md5": "a0d379bf3c8eae8d3e7c6b4dbf1e52ef",
"sha256": "5e8828a15beb960c7ac831669324b1ce34c341118aade00f87ded3dc85b4047b"
},
"downloads": -1,
"filename": "fluiddyn-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a0d379bf3c8eae8d3e7c6b4dbf1e52ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 161792,
"upload_time": "2024-12-20T11:49:50",
"upload_time_iso_8601": "2024-12-20T11:49:50.401198Z",
"url": "https://files.pythonhosted.org/packages/c9/96/0359959960f4f7d8fbfafc763ee465e4544e893201d97537830dbc6a7630/fluiddyn-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "53f2edc673546ee42e3fce14490ce38798a81eef46438db09fa9136e9f172ca3",
"md5": "b0191140fc42d316d768f7abb2a67b71",
"sha256": "248996245cc3e59c4b32be3dde9f644f775d1ca1d45dfb1b94b70d5fb205488b"
},
"downloads": -1,
"filename": "fluiddyn-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "b0191140fc42d316d768f7abb2a67b71",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 123415,
"upload_time": "2024-12-20T11:49:53",
"upload_time_iso_8601": "2024-12-20T11:49:53.046744Z",
"url": "https://files.pythonhosted.org/packages/53/f2/edc673546ee42e3fce14490ce38798a81eef46438db09fa9136e9f172ca3/fluiddyn-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-20 11:49:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "conda-forge",
"github_project": "fluiddyn-feedstock",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"lcname": "fluiddyn"
}
