Installation

Installation of DOLFINx requires installation of the C++ core. Most users will also want the Python interface.

Dependencies

C++ core

Required

Optional

  • KaHIP

  • ParMETIS 1

  • SLEPc

Python interface

Below are additional requirements for the Python interface.

Required

Suggested

  • pyvista (required for plotting)

  • Numba

  • slepc4py

Building and installing

C++ core

The C++ core is built using CMake. Create a build directory in cpp/, e.g. mkdir -p build/ and in the build run directory:

cmake ../
make install

To set the installation prefix:

cmake -DCMAKE_INSTALL_PREFIX=<my-install-path> ../
make install

Python

After installation of the C++ core, from the python/ directory the Python interface can be installed using:

pip install .

Docker container

A Docker container is available at https://hub.docker.com/r/dolfinx/dolfinx. The Dockerfile provides a definitive build recipe.

Footnotes

1(1,2)

It is strongly recommended to use the PETSc build system to download and configure and build these libraries.

2

Its is recommended to configure with ParMETIS, PT-SCOTCH, MUMPS and Hypre using the --download-parmetis --download-ptscotch --download-suitesparse --download-mumps --download-hypre