Installation

Requirements

Unix systems (Linux and MacOS)

MPI.jl requires:

  • A shared library MPI installation for C (supporting MPI standard 3.0), and
  • A C compiler available via the mpicc command: this is required as part of the build process to determine the necessary type definitions and constants.

This has been tested with:

Windows

MPI.jl requires the Microsoft MPI (MS-MPI) runtime to be installed.

Building

The MPI.jl package can be installed via add MPI in the Julia package manager.

The build script will attempt to find the shared library and constants: this can be controlled with the optional environment variables:

  • JULIA_MPI_PATH: the top-level installation directory of MPI.
  • JULIA_MPI_LIBRARY: the path of the MPI shared library.
  • JULIA_MPI_LIBRARY_PATH: the directory containing the MPI library files.
  • JULIA_MPI_INCLUDE_PATH: the directory containing the MPI header files.
  • JULIA_MPI_CFLAGS: C flags passed to the constant generation build (default: -lmpi)
  • JULIA_MPICC: MPI C compiler (default: mpicc)
  • JULIA_MPIEXEC: MPI startup command (default: mpiexec)

If your MPI installation changes (e.g. it is upgraded by the system, or you switch libraries), you will need to re-run build MPI at the package prompt.