muFFT 0.91.2

Unified interface to MPI-parallel FFT libraries

µFFT

µFFT is a unified interface to serial and MPI-parallel FFT libraries, build on top of µGrid. µGrid and µFFT make it easy to implement algorithms that operate on fields, such as solving partial differential equations. It supports parallelization using domain decomposition implemented using the Message Passing Interface (MPI).

µFFT is written in C++ and currently has language bindings for Python.

This README contains only a small quick start guide. Please refer to the full documentation for more help.

Quick start

To install µFFT, run

pip install muFFT

Note that on most platforms this will install a binary wheel, that was compiled with a minimal configuration. To compile for your specific platform use

pip install -v --no-binary muFFT muFFT

which will compile the code. µFFT will autodetect µFFT will autodetect MPI, FFTW, MPIFFTW and PFFT. Monitor output to see which of these options were automatically detected.

Funding

This development has received funding from the Swiss National Science Foundation within an Ambizione Project and by the European Research Council within Starting Grant 757343.