{"id":22127457,"url":"https://github.com/fluiddyn/fluidfft","last_synced_at":"2025-08-27T07:22:08.891Z","repository":{"id":100841533,"uuid":"96234592","full_name":"fluiddyn/fluidfft","owner":"fluiddyn","description":":chart_with_upwards_trend: Common API (C++ and Python) for Fast Fourier Transform HPC libraries (publish-only mirror)","archived":false,"fork":false,"pushed_at":"2025-07-22T15:12:18.000Z","size":2383,"stargazers_count":10,"open_issues_count":1,"forks_count":1,"subscribers_count":4,"default_branch":"branch/default","last_synced_at":"2025-07-22T16:31:23.405Z","etag":null,"topics":["cuda","cython","fft","fftw3-binding","mpi","pythran","spectral-methods"],"latest_commit_sha":null,"homepage":"https://foss.heptapod.net/fluiddyn/fluidfft","language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fluiddyn.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-07-04T16:01:46.000Z","updated_at":"2025-07-22T15:12:23.000Z","dependencies_parsed_at":"2024-01-30T15:41:42.440Z","dependency_job_id":"4a2ff658-fc9f-4cc3-834a-fa06c09a7de7","html_url":"https://github.com/fluiddyn/fluidfft","commit_stats":{"total_commits":630,"total_committers":5,"mean_commits":126.0,"dds":0.6063492063492064,"last_synced_commit":"a9c7d29501b2135a06029c6ee03df5d52b334ce8"},"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"purl":"pkg:github/fluiddyn/fluidfft","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluiddyn%2Ffluidfft","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluiddyn%2Ffluidfft/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluiddyn%2Ffluidfft/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluiddyn%2Ffluidfft/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fluiddyn","download_url":"https://codeload.github.com/fluiddyn/fluidfft/tar.gz/refs/heads/branch/default","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluiddyn%2Ffluidfft/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266533532,"owners_count":23944244,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cuda","cython","fft","fftw3-binding","mpi","pythran","spectral-methods"],"created_at":"2024-12-01T17:18:55.050Z","updated_at":"2025-07-25T17:31:32.913Z","avatar_url":"https://github.com/fluiddyn.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![FluidFFT](https://foss.heptapod.net/fluiddyn/fluidfft/-/blob/branch/default/doc/logo.svg)\n===========================================================================================\n\n*Efficient and easy Fast Fourier Transform for Python*\n\n[![Latest version](https://img.shields.io/pypi/v/fluidfft.svg)](https://pypi.org/project/fluidfft/)\n![Supported Python versions](https://img.shields.io/pypi/pyversions/fluidfft.svg)\n[![Documentation status](https://readthedocs.org/projects/fluidfft/badge/?version=latest)](http://fluidfft.readthedocs.org)\n[![Code coverage](https://codecov.io/gh/fluiddyn/fluidfft/branch/branch%2Fdefault/graph/badge.svg)](https://codecov.io/gh/fluiddyn/fluidfft)\n[![Heptapod CI](https://foss.heptapod.net/fluiddyn/fluidfft/badges/branch/default/pipeline.svg)](https://foss.heptapod.net/fluiddyn/fluidfft/-/pipelines)\n[![Github Actions Linux](https://github.com/fluiddyn/fluidfft/actions/workflows/ci-linux.yml/badge.svg?branch=branch/default)](https://github.com/fluiddyn/fluidfft/actions/workflows/ci-linux.yml)\n[![Github Actions Pixi](https://github.com/fluiddyn/fluidfft/actions/workflows/ci-pixi.yml/badge.svg?branch=branch/default)](https://github.com/fluiddyn/fluidfft/actions/workflows/ci-pixi.yml)\n\nFluidfft provides C++ classes and their Python wrapper classes written\nin Cython useful to perform Fast Fourier Transform (FFT) with different\nlibraries, in particular\n\n-   [fftw3](http://www.fftw.org/) and\n    [fftw3-mpi](http://www.fftw.org/fftw3_doc/Distributed_002dmemory-FFTW-with-MPI.html)\n-   [pfft](https://github.com/mpip/pfft)\n-   [p3dfft](https://github.com/sdsc/p3dfft)\n-   [mpi4py-fft](https://bitbucket.org/mpi4py/mpi4py-fft)\n-   [cufft](https://developer.nvidia.com/cufft) (fft library by CUDA\n    running on GPU)\n\n[pfft](https://github.com/mpip/pfft),\n[p3dfft](https://github.com/sdsc/p3dfft) and\n[mpi4py-fft](https://bitbucket.org/mpi4py/mpi4py-fft) are specialized in\ncomputing FFT efficiently on several cores of big clusters. The data can\nbe split in pencils and can be distributed on several processes.\n\n**Documentation**: \u003chttps://fluidfft.readthedocs.io\u003e\n\nGetting started\n---------------\n\nTo try fluidfft without installation:\n[![Binder notebook](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fluiddyn/fluidfft/branch%2Fdefault?urlpath=lab/tree/doc/ipynb)\n\nFor a **basic installation** which relies only on a `pyFFTW` interface;\nor provided you have the optional FFT libaries, that you need, installed\nand discoverable in your path (see environment variables `LIBRARY_PATH`,\n`LD_LIBRARY_PATH`, `CPATH`) it should be sufficient to run:\n\n    pip install fluidfft [--user]\n\nAdd `--user` flag if you are installing without setting up a virtual\nenvironment.\n\nInstallation\n------------\n\nTo take full advantage of fluidfft, consider installing the following\n(optional) dependencies and configurations before installing fluidfft.\nClick on the links to know more:\n\n1.  OpenMPI or equivalent\n2.  FFT libraries such as MPI-enabled FFTW (for 2D and 3D solvers) and\n    P3DFFT, PFFT (for 3D solvers) either using a package manager or\n    [from\n    source](https://fluidfft.readthedocs.io/en/latest/install/fft_libs.html)\n3.  Python packages `fluiddyn cython pyfftw pythran mpi4py`\n4.  [A C++11 compiler and BLAS\n    libraries](https://github.com/serge-sans-paille/pythran#installation)\n    and\n    [configure](https://fluidfft.readthedocs.io/en/latest/install.html#dependencies)\n    `~/.pythranrc` to customize compilation of Pythran extensions\n5.  [Configure](https://fluidfft.readthedocs.io/en/latest/install.html#basic-installation-with-pip)\n    `~/.fluidfft-site.cfg` to detect the FFT libraries and install\n    `fluidfft`\n\n**Note**: Detailed instructions to install the above dependencies using\nAnaconda / Miniconda or in a specific operating system such as Ubuntu,\nmacOS etc. can be found\n[here](https://fluiddyn.readthedocs.io/en/latest/get_good_Python_env.html).\n\n### C++ API\n\nSee a [working minimal example with\nMakefile](https://fluidfft.readthedocs.io/en/latest/examples/cpp.html)\nwhich illustrates how to use the C++ API.\n\nTests\n-----\n\nFrom the root directory:\n\n    make tests\n    make tests_mpi\n\nOr, from the root directory or any of the \\\"test\\\" directories:\n\n    pytest -s\n    mpirun -np 2 pytest -s\n\nHow does it work?\n-----------------\n\nFluidfft provides classes to use in a transparent way all these\nlibraries with an unified API. These classes are not limited to just\nperforming Fourier transforms. They are also an elegant solution to\nefficiently perform operations on data in real and spectral spaces\n(gradient, divergence, rotational, sum over wavenumbers, computation of\nspectra, etc.) and easily deal with the data distribution (gather the\ndata on one process, scatter the data to many processes) without having\nto know the internal organization of every FFT library.\n\nFluidfft hides the internal complication of (distributed) FFT libraries\nand allows the user to find (by benchmarking) and to choose the most\nefficient solution for a particular case. Fluidfft is therefore a very\nuseful tool to write HPC applications using FFT, as for example\npseudo-spectral simulation codes. In particular, fluidfft is used in the\nComputational Fluid Dynamics (CFD) framework\n[fluidsim](http://fluidsim.readthedocs.org).\n\nLicense\n-------\n\nFluidfft is distributed under the\n[CeCILL](http://www.cecill.info/index.en.html) License, a GPL compatible\nfrench license.\n\nMetapapers and citations\n------------------------\n\nIf you use FluidFFT to produce scientific articles, please cite our\nmetapapers presenting the [FluidDyn\nproject](https://openresearchsoftware.metajnl.com/articles/10.5334/jors.237/)\nand\n[Fluidfft](https://openresearchsoftware.metajnl.com/articles/10.5334/jors.238/):\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffluiddyn%2Ffluidfft","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffluiddyn%2Ffluidfft","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffluiddyn%2Ffluidfft/lists"}