Getting Started¶

Python quick start¶

To install µFFT’s Python bindings, 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 --force-reinstall --no-cache --no-binary muGrid --no-binary muFFT muFFT

which will compile the code. µFFT will autodetect MPI, FFTW, MPIFFTW and PFFT. Monitor the output to see what was detected. You should see something like:

Message:   -------------------
Message:   muFFT configuration
Message:     MPI      : *** YES ***
Message:     pocketfft: *** YES ***
Message:     FFTW3    : *** YES ***
Message:     FFTW3 MPI: *** YES ***
Message:     PFFT     : *** YES ***
Message:   -------------------

Dependencies quick start¶

µFFT needs the above dependencies for full functionality, and addition µGrid needs PnetCDF. We provide a convenience script that will download and compile all dependencies as static libraries. We use static libraries to avoid any run-time dependencies with in µGrid and µFFT.

To install these dependencies, run

curl -sSL https://raw.githubusercontent.com/muSpectre/muFFT/main/install_dependencies.sh | sh

Installation defaults to $HOME/.local, but you can specify a different a different location by through the PREFIX environment variable.

When building µFFT, you may need to specify the location of these dependencies:

PKG_CONFIG_PATH=$HOME/.local/lib/pkgconfig:$PKG_CONFIG_PATH \
    LIBRARY_PATH=$HOME/.local/lib:$LIBRARY_PATH \
    CPATH=$HOME/.local/include:$CPATH \
    pip install -v \
        --force-reinstall --no-cache \
        --no-binary muGrid --no-binary muFFT \
        muGrid muFFT

Obtaining µFFT’s source code¶

µFFT is hosted on a git repository on GitHub. To clone it, run

$ git clone https://github.com/muSpectre/muFFT.git

or if you prefer identifying yourself using a public ssh-key, run

$ git clone git@github.com:muSpectre/muFFT.git

The latter option requires a user account on GitHub.

Building µFFT¶

µFFT uses Meson as its build system.

The current (and possibly incomplete list of) dependencies are

Meson
git
Python3 including the header files
numpy

The following dependencies are included as Meson subprojects:

pybind11 (2.2.4 or higher)
Eigen (3.4.0 or higher)

The following dependencies are optional:

The following dependencies are necessary if you want to build the documentation:

µFFT requires a relatively modern compiler as it makes heavy use of C++17 features.

To compile for development, i.e. with debug options turned on, first setup the build folder:

$ meson setup meson-build-debug

To compile for production, i.e. with code optimizations turned on, setup the build folder while specifying the release build type.

$ meson setup --buildtype release meson-build-release

The compilation is typically handled by ninja. Navigate to the build folder and run:

$ meson compile

Getting help and reporting bugs¶

µFFT is under active development and the documentation may be spotty. If you run into trouble, please contact us by opening an issue and someone will answer as soon as possible. You can also check the API reference.

Contribute¶

We welcome contributions both for new features and bug fixes. New features must be documented and have unit tests. Please submit pull requests for review.