fluidimage

:sparkler: A libre Python framework for scientific treatments of large series of images (publish-only mirror)

https://github.com/fluiddyn/fluidimage

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.3%) to scientific vocabulary

Keywords

image-processing particle-image-velocimetry piv postprocessing
Last synced: 6 months ago · JSON representation ·

Repository

:sparkler: A libre Python framework for scientific treatments of large series of images (publish-only mirror)

Basic Info
Statistics
  • Stars: 18
  • Watchers: 5
  • Forks: 4
  • Open Issues: 0
  • Releases: 0
Topics
image-processing particle-image-velocimetry piv postprocessing
Created over 8 years ago · Last pushed 9 months ago
Metadata Files
Readme Changelog Contributing License Citation Authors

README.md

FluidImage

Latest version Supported Python versions Documentation status Code coverage Heptapod CI Github Actions Linux Github Actions Pixi

FluidImage is a free and open-source Python framework to process images of fluids (in particular with PIV), and analyse the resulting fields.

Documentation: http://fluidimage.readthedocs.org

Image processing for fluid mechanics is still dominated by proprietary tools. Such tools are not ideal when you want to understand and tweak the algorithms and/or to use clusters. There are also good and useful PIV software (PIVlab, UVmat) written in Matlab, which is itself proprietary.

With the improvement of the Python numerical ecosystem and of tools for collaborative development, one can think it is possible to build together a good community-driven library/toolkit specialized in image processing for fluid mechanics. This is our project with FluidImage.

Fluidimage has now grown into a clean software reimplementing in modern Python algorithms and ideas taken from UVmat, OpenPIV, PIVlab and PIVmat with a focus on performance, usability and maintanability. However, Fluidimage is not restricted to Particle Image Velocimetry computations (PIV, i.e. displacements of pattern obtained by correlations of cropped images) and can be used to

  • display and pre-process images,

  • compute displacement or velocity fields with PIV, Background-Oriented Schlieren (BOS) and optical flow,

  • analyze and display vector and scalar fields.

We want to make FluidImage easy (useful documentation, easy installation, nice API, usable with simple scripts and few simple graphical user interfaces), reliable (with good unittests) and very efficient, in particular when the number of images is large. Thus we want FluidImage to be able to run efficiently and easily on a personal computer and on big clusters. The efficiency is achieved by using

  • a framework for asynchronous computations (currently, we use Trio) and an associated API to define "topologies" of parallel computations.

  • parallelism to efficiently use the available cores of the Central Processing Units (CPU),

  • good profiling and efficient and specialized algorithms,

  • cutting-edge tools for fast computations with Python (in particular Pythran through Transonic).

Owner

  • Name: FluidDyn
  • Login: fluiddyn
  • Kind: organization

FluidDyn project | framework for research and teaching in fluid dynamics - git mirror

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use this software, please cite it using these metadata.
title: "Fluidimage: a Python framework to study flows from images"
abstract: |
  Fluid mechanics experimental studies are often based on image processing,
  with various algorithms such as Particle Image Velocimetry (PIV) or
  Light Induced Fluorescence (LIF) used to compute velocity, vorticity, concentration
  or temperature fields. Fluidimage is a free and open-source Python framework
  to process images of fluids and analyse the resulting fields.
authors:

  - family-names: Augier
    given-names: Pierre
    orcid: https://orcid.org/0000-0001-9481-4459

# Note: the values of "version" and "date-released" might not correspond to the last uploaded version.
# The correct values are in the file pyproject.toml and CHANGES.md.
version: 0.5.2
date-released: "2024-05-24"
identifiers:
  - description: This is the collection of archived snapshots of all versions of Fluidimage
    type: doi
    value: "10.5281/zenodo.11359207"
license: CECILL-2.1
repository-code: "https://foss.heptapod.net/fluiddyn/fluidimage"

GitHub Events

Total
  • Watch event: 3
  • Delete event: 3
  • Push event: 17
  • Create event: 6
Last Year
  • Watch event: 3
  • Delete event: 3
  • Push event: 17
  • Create event: 6

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 year
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 2.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (1)

Dependencies

.github/workflows/ci.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite
environment.yml conda
  • fftw
  • h5py
  • jupyter
  • matplotlib
  • mpi4py
  • numpy
  • pyfftw
  • python 3.6.*
  • scipy
requirements/dev.txt pypi
  • alabaster ==0.7.12 development
  • anyio ==3.6.2 development
  • argon2-cffi ==21.3.0 development
  • argon2-cffi-bindings ==21.2.0 development
  • arrow ==1.2.3 development
  • asttokens ==2.2.1 development
  • async-generator ==1.10 development
  • attrs ==22.1.0 development
  • autopep8 ==2.0.0 development
  • babel ==2.11.0 development
  • backcall ==0.2.0 development
  • beautifulsoup4 ==4.11.1 development
  • beniget ==0.4.1 development
  • bleach ==5.0.1 development
  • certifi ==2022.12.7 development
  • cffi ==1.15.1 development
  • charset-normalizer ==2.1.1 development
  • click ==8.1.3 development
  • cloudpickle ==2.2.0 development
  • comm ==0.1.2 development
  • commonmark ==0.9.1 development
  • contourpy ==1.0.6 development
  • coverage ==6.5.0 development
  • cycler ==0.11.0 development
  • dask ==2022.12.0 development
  • debugpy ==1.6.4 development
  • decorator ==5.1.1 development
  • defusedxml ==0.7.1 development
  • distro ==1.8.0 development
  • docutils ==0.17.1 development
  • entrypoints ==0.4 development
  • exceptiongroup ==1.0.4 development
  • executing ==1.2.0 development
  • fastjsonschema ==2.16.2 development
  • fluiddyn ==0.5.1 development
  • fonttools ==4.38.0 development
  • fqdn ==1.5.1 development
  • fsspec ==2022.11.0 development
  • gast ==0.5.3 development
  • h5netcdf ==1.1.0 development
  • h5py ==3.7.0 development
  • idna ==3.4 development
  • imageio ==2.22.4 development
  • imagesize ==1.4.1 development
  • importlib-metadata ==5.1.0 development
  • iniconfig ==1.1.1 development
  • ipykernel ==6.19.2 development
  • ipython ==8.7.0 development
  • ipython-genutils ==0.2.0 development
  • ipywidgets ==8.0.3 development
  • isoduration ==20.11.0 development
  • jedi ==0.18.2 development
  • jinja2 ==3.1.2 development
  • jsonpointer ==2.3 development
  • jsonschema ==4.17.3 development
  • jupyter ==1.0.0 development
  • jupyter-client ==7.4.8 development
  • jupyter-console ==6.4.4 development
  • jupyter-core ==5.1.0 development
  • jupyter-events ==0.5.0 development
  • jupyter-server ==2.0.1 development
  • jupyter-server-terminals ==0.4.2 development
  • jupyterlab-pygments ==0.2.2 development
  • jupyterlab-widgets ==3.0.4 development
  • kiwisolver ==1.4.4 development
  • locket ==1.0.0 development
  • markupsafe ==2.1.1 development
  • matplotlib ==3.6.2 development
  • matplotlib-inline ==0.1.6 development
  • mistune ==2.0.4 development
  • nbclassic ==0.4.8 development
  • nbclient ==0.7.2 development
  • nbconvert ==7.2.6 development
  • nbformat ==5.7.0 development
  • nbsphinx ==0.8.10 development
  • nest-asyncio ==1.5.6 development
  • networkx ==2.8.8 development
  • notebook ==6.5.2 development
  • notebook-shim ==0.2.2 development
  • numpy ==1.23.5 development
  • numpydoc ==1.5.0 development
  • opencv-python ==4.6.0.66 development
  • outcome ==1.2.0 development
  • packaging ==22.0 development
  • pandocfilters ==1.5.0 development
  • parso ==0.8.3 development
  • partd ==1.3.0 development
  • pexpect ==4.8.0 development
  • pickleshare ==0.7.5 development
  • pillow ==9.3.0 development
  • pims ==0.6.1 development
  • platformdirs ==2.6.0 development
  • pluggy ==1.0.0 development
  • prometheus-client ==0.15.0 development
  • prompt-toolkit ==3.0.36 development
  • psutil ==5.9.4 development
  • ptyprocess ==0.7.0 development
  • pure-eval ==0.2.2 development
  • pycodestyle ==2.10.0 development
  • pycparser ==2.21 development
  • pyfftw ==0.13.0 development
  • pygments ==2.13.0 development
  • pyparsing ==3.0.9 development
  • pyqt5 ==5.14.2 development
  • pyqt5-sip ==12.11.0 development
  • pyrsistent ==0.19.2 development
  • pytest ==7.2.0 development
  • pytest-cov ==4.0.0 development
  • pytest-qt ==4.2.0 development
  • python-dateutil ==2.8.2 development
  • python-json-logger ==2.0.4 development
  • pytz ==2022.6 development
  • pywavelets ==1.4.1 development
  • pyyaml ==6.0 development
  • pyzmq ==24.0.1 development
  • qtconsole ==5.4.0 development
  • qtpy ==2.3.0 development
  • recommonmark ==0.7.1 development
  • requests ==2.28.1 development
  • rfc3339-validator ==0.1.4 development
  • rfc3986-validator ==0.1.1 development
  • scikit-image ==0.19.3 development
  • scipy ==1.9.3 development
  • send2trash ==1.8.0 development
  • six ==1.16.0 development
  • slicerator ==1.1.0 development
  • sniffio ==1.3.0 development
  • snowballstemmer ==2.2.0 development
  • sortedcontainers ==2.4.0 development
  • soupsieve ==2.3.2.post1 development
  • sphinx ==5.3.0 development
  • sphinx-rtd-theme ==1.1.1 development
  • sphinxcontrib-applehelp ==1.0.2 development
  • sphinxcontrib-devhelp ==1.0.2 development
  • sphinxcontrib-htmlhelp ==2.0.0 development
  • sphinxcontrib-jsmath ==1.0.1 development
  • sphinxcontrib-qthelp ==1.0.3 development
  • sphinxcontrib-serializinghtml ==1.1.5 development
  • stack-data ==0.6.2 development
  • terminado ==0.17.1 development
  • tifffile ==2022.10.10 development
  • tinycss2 ==1.2.1 development
  • tomli ==2.0.1 development
  • toolz ==0.12.0 development
  • tornado ==6.2 development
  • traitlets ==5.7.0 development
  • transonic ==0.5.1 development
  • trio ==0.22.0 development
  • uri-template ==1.2.0 development
  • urllib3 ==1.26.13 development
  • wcwidth ==0.2.5 development
  • webcolors ==1.12 development
  • webencodings ==0.5.1 development
  • websocket-client ==1.4.2 development
  • widgetsnbextension ==4.0.4 development
  • zipp ==3.11.0 development
requirements/doc.txt pypi
  • 150 dependencies
requirements/main.txt pypi
  • asttokens ==2.2.1
  • async-generator ==1.10
  • attrs ==22.1.0
  • autopep8 ==2.0.0
  • backcall ==0.2.0
  • beniget ==0.4.1
  • click ==8.1.3
  • cloudpickle ==2.2.0
  • contourpy ==1.0.6
  • cycler ==0.11.0
  • dask ==2022.12.0
  • decorator ==5.1.1
  • distro ==1.8.0
  • exceptiongroup ==1.0.4
  • executing ==1.2.0
  • fluiddyn ==0.5.1
  • fonttools ==4.38.0
  • fsspec ==2022.11.0
  • gast ==0.5.3
  • h5netcdf ==1.1.0
  • h5py ==3.7.0
  • idna ==3.4
  • imageio ==2.22.4
  • ipython ==8.7.0
  • jedi ==0.18.2
  • kiwisolver ==1.4.4
  • locket ==1.0.0
  • matplotlib ==3.6.2
  • matplotlib-inline ==0.1.6
  • networkx ==2.8.8
  • numpy ==1.23.5
  • opencv-python ==4.6.0.66
  • outcome ==1.2.0
  • packaging ==22.0
  • parso ==0.8.3
  • partd ==1.3.0
  • pexpect ==4.8.0
  • pickleshare ==0.7.5
  • pillow ==9.3.0
  • pims ==0.6.1
  • prompt-toolkit ==3.0.36
  • psutil ==5.9.4
  • ptyprocess ==0.7.0
  • pure-eval ==0.2.2
  • pycodestyle ==2.10.0
  • pyfftw ==0.13.0
  • pygments ==2.13.0
  • pyparsing ==3.0.9
  • python-dateutil ==2.8.2
  • pywavelets ==1.4.1
  • pyyaml ==6.0
  • qtpy ==2.3.0
  • scikit-image ==0.19.3
  • scipy ==1.9.3
  • six ==1.16.0
  • slicerator ==1.1.0
  • sniffio ==1.3.0
  • sortedcontainers ==2.4.0
  • stack-data ==0.6.2
  • tifffile ==2022.10.10
  • tomli ==2.0.1
  • toolz ==0.12.0
  • traitlets ==5.7.0
  • transonic ==0.5.1
  • trio ==0.22.0
  • wcwidth ==0.2.5
requirements/test.txt pypi
  • asttokens ==2.2.1 test
  • async-generator ==1.10 test
  • attrs ==22.1.0 test
  • autopep8 ==2.0.0 test
  • backcall ==0.2.0 test
  • beniget ==0.4.1 test
  • click ==8.1.3 test
  • cloudpickle ==2.2.0 test
  • contourpy ==1.0.6 test
  • coverage ==6.5.0 test
  • cycler ==0.11.0 test
  • dask ==2022.12.0 test
  • decorator ==5.1.1 test
  • distro ==1.8.0 test
  • exceptiongroup ==1.0.4 test
  • executing ==1.2.0 test
  • fluiddyn ==0.5.1 test
  • fonttools ==4.38.0 test
  • fsspec ==2022.11.0 test
  • gast ==0.5.3 test
  • h5netcdf ==1.1.0 test
  • h5py ==3.7.0 test
  • idna ==3.4 test
  • imageio ==2.22.4 test
  • iniconfig ==1.1.1 test
  • ipython ==8.7.0 test
  • jedi ==0.18.2 test
  • kiwisolver ==1.4.4 test
  • locket ==1.0.0 test
  • matplotlib ==3.6.2 test
  • matplotlib-inline ==0.1.6 test
  • networkx ==2.8.8 test
  • numpy ==1.23.5 test
  • opencv-python ==4.6.0.66 test
  • outcome ==1.2.0 test
  • packaging ==22.0 test
  • parso ==0.8.3 test
  • partd ==1.3.0 test
  • pexpect ==4.8.0 test
  • pickleshare ==0.7.5 test
  • pillow ==9.3.0 test
  • pims ==0.6.1 test
  • pluggy ==1.0.0 test
  • prompt-toolkit ==3.0.36 test
  • psutil ==5.9.4 test
  • ptyprocess ==0.7.0 test
  • pure-eval ==0.2.2 test
  • pycodestyle ==2.10.0 test
  • pyfftw ==0.13.0 test
  • pygments ==2.13.0 test
  • pyparsing ==3.0.9 test
  • pyqt5 ==5.14.2 test
  • pyqt5-sip ==12.11.0 test
  • pytest ==7.2.0 test
  • pytest-cov ==4.0.0 test
  • pytest-qt ==4.2.0 test
  • python-dateutil ==2.8.2 test
  • pywavelets ==1.4.1 test
  • pyyaml ==6.0 test
  • qtpy ==2.3.0 test
  • scikit-image ==0.19.3 test
  • scipy ==1.9.3 test
  • six ==1.16.0 test
  • slicerator ==1.1.0 test
  • sniffio ==1.3.0 test
  • sortedcontainers ==2.4.0 test
  • stack-data ==0.6.2 test
  • tifffile ==2022.10.10 test
  • tomli ==2.0.1 test
  • toolz ==0.12.0 test
  • traitlets ==5.7.0 test
  • transonic ==0.5.1 test
  • trio ==0.22.0 test
  • wcwidth ==0.2.5 test