CMake installation instructions
The CMake build system is used to build ECMWF software. The build process comprises two stages:
- CMake runs some tests on the system and finds out if required software libraries and headers are available. It uses this information to create native build tools (e.g. Makefiles) for the current platform.
- The actual build can take place, for example by typing '
make'.
Prerequisite
To install any ECMWF software package, CMake needs to be installed on your system. On most systems it will be already installed or this can be done through the standard package manager to install software. For further information to install CMake see
http://www.cmake.org/cmake/help/install.html
Directories
During a build with CMake there are three different directories involved: The source dir, the build dir and the install dir.
...
| Note |
|---|
ECMWF software does not support in-source builds. Therefore the build directory cannot be (a subdirectory of) the source directory. |
Quick Build Example
Here is an example set of commands to set up and build a software package using default settings. More detail for a customised build is given below.
...
| Code Block | ||
|---|---|---|
| ||
make install |
General CMake options
Various options can be passed to the CMake command. The following table gives an overview of some of the general options that can be used. Options are passed to the cmake command by prefixing them with -D, for example -DCMAKE_INSTALL_PREFIX=/path/to/dir.
...
If any support libraries are installed in non-default locations, CMake can be instructed where to find them by one of the following methods. First, the option CMAKE_PREFIX_PATH can be set to a colon-separated list of base directories where the libraries are installed, for example -DCMAKE_PREFIX_PATH=/path/where/my/sw/is/installed. CMake will check these directories for any package it requires. This method is therefore useful if many support libraries are installed into the same location.
Troubleshooting
Debugging configure failures
If CMake fails to configure your project, run with debug logging first:
| Code Block |
|---|
cmake -DECBUILD_LOG_LEVEL=DEBUG [...] /path/to/source |
This will output lots of diagnostic information (in blue) on discovery of dependencies and much more.