Directory dependency graph for cmake_doc:

Detailed Description

Requirements

The CMake configuration of Gaudi is based on the version 3.15.0 or later of CMake. On lxplus (SLC6 and CentOS7) you need to call something like:

$ export PATH=/cvmfs/sft.cern.ch/lcg/contrib/CMake/3.18.3/Linux-x86_64/bin:$PATH

Quick Start

Gaudi requires some uncommon external libraries, so the quickest way to build it is to use the CERN SFT provided LCG views, for example:

. /cvmfs/sft.cern.ch/lcg/views/LCG_101/x86_64-centos7-gcc11-opt/setup.sh

We suggest the use of Ninja to build, if you wish to do so, you can use these settings:

export CMAKE_GENERATOR=Ninja

At this point the environment is good enough to use a standard CMake procedure:

cd Gaudi
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build

Run from the build directory

For testing and debugging there is no need to install, but Gaudi requires some environment variables to be set, so the build procedure generates a special script (build/run) that can be used to run a command in the correct environment, for example:

build/run gaudirun.py --help

or

build/run bash

to have a shell with the correct environment.

Testing

Gaudi comes with a pool of tests (built by default, unless one passes the option -DBUILD_TESTING=FALSE to Gaudi) that can be run with ctest:

cd build

ctest

Resources

CMake documentation