preCICE uses CMake to configure and build the library. After this step, preCICE is ready to be build.

Build directory

CMake keeps track of the source and the build directory separately. This allows to cleanly create multiple build configurations for a single source directory.

Please create a build directory inside the preCICE source directory as follows:

cd precice-2.2.0 # Enter the preCICE source directory
mkdir build
cd build

Options

Now it is time to configure preCICE with the decisions taken during the preparation. First make sure that you changed into the build directory.

If you need to configure a debug build with all default settings, simply run:

cmake -DBUILD_SHARED_LIBS=ON ..

As you can see, you can pass variables to cmake using the syntax -DNAME=VALUE. The following table lists the most important options to pass to CMake.

Assemble your CMake command and run it to configure preCICE.

This example builds the release version of preCICE with the PETSc mapping and the user-defined python actions off, which will be installed in the prefix ~/software/precice.

cmake -DBUILD_SHARED_LIBS=ON -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=~/software/precice -DPRECICE_PETScMapping=OFF -DPRECICE_PythonActions=OFF ..
Option Type Default Description
BUILD_SHARED_LIBS Boolean OFF Build as a shared library.
CMAKE_BUILD_TYPE String Debug Choose Debug, Release, or RelWithDebInfo.
CMAKE_INSTALL_PREFIX Path /usr/local The prefix used in the installation step.
PRECICE_MPICommunication Boolean ON Build with MPI.
MPI_CXX_COMPILER Path   MPI compiler wrapper to use for detection.
PRECICE_PETScMapping Boolean ON Build with PETSc (for MPI-parallel RBF mapping), requires PRECICE_MPICommunication=ON.
PRECICE_PythonActions Boolean ON Build support for python actions.
PYTHON_EXECUTABLE Path   Path to the python interpreter to use.
BUILD_TESTING Boolean ON Build and register the tests.
PRECICE_InstallTest Boolean OFF Install testprecice and test configuration files.
PRECICE_Packages Boolean ON Enable package configuration.
PRECICE_ENABLE_C Boolean ON Enable the native C bindings.
PRECICE_ENABLE_FORTRAN Boolean ON Enable the native Fortran bindings.
PRECICE_ALWAYS_VALIDATE_LIBS Boolean OFF Force CMake to always validate required libraries.
PRECICE_TEST_TIMEOUT_LONG Integer 180 Timeout for big test suites
PRECICE_TEST_TIMEOUT_SHORT Integer 20 Timout for small test suites
PRECICE_CTEST_MPI_FLAGS String   Additional flags to pass to mpiexec when running the tests.

The next step

preCICE is now configured and the build system has been generated. The next step covers how to build preCICE.