CMake

This page is divided into the following sections:

Compiling TNG

For compiling TNG you need to install the following tools:

cmake: http://www.cmake.org/
git: http://git-scm.com/
gcc (C++, C, Fortran)
lapack/blas
MPI-devel
sed
make

TNG ships log4cxx and APR (Apache Portable Runtime project) which require

pthread
uuid

Although cmake is heavily used to create a makefile environment the main makefile in the root directory must never be overwritten.

You can get a help screen using

 make help

The idea is to compile external "third-party" libraries and own sources in separate environments.

The external libs are located in the path ./Externals and can be compiled and cleaned by

make externals 
make clean_externals

The TNG sources are distinguished into modules (separated libraries) and drivers (executables). Each of these parts provides its own testing environment and CMake build tree/Makefiles. But it is possible to compile all in one build tree using the Makefile in the root directory:

 make

 make clean

deletes all libs and objects

 make distclean

deletes the build tree and the CMake cache as well.

With CMake you can compile using parallel compiler processes. If any errors occur it is a matter of wrong dependencies in your CMakelists.txt files. At the moment in order to start XX processes, you have to type:

make -jXX

In order to compile this documentation, type

make cmake doc

Adding a module

Modules are encapsulated parts which are NOT third-party libraries, but which may be considered as standalone libraries. They may depend on TNG's external libraries and on other modules. They are encapsulated in order to enable and disable certain functionalities.

A module must be added to the module directory with the following directory structure:

/modules/name is the module main directory
/modules/name/CMakeLists.txt describes the cmake instructions for this module
/modules/name/name should contain all C++, C, Fortran source files
/modules/name/doc/src/Doxyfile.in is the template for Doxyfile generated by cmake and used for compiling the API documentation. It usually does not differ from /doc/src/Doxyfile.in
/modules/name/doc/src/mainpage.dox should at least contain a link to the parent documentation
/modules/name/doc/src/ should contain further input files used by doxygen

Any module must be announced to configuration files in the upper levels. In /modules/CMakeLists.txt one has to add the new module to the list of modules and one has to set its dependencies, but only the dependencies onto other modules. Dependencies on external libraries must be defined in the own CMakeLists.txt.

The usual CMakeLists.txt

defines a list of directories where all source files are automatically fetched from,
defines a list of test drivers (each test driver should be a single source file),
defines a list of include directories and libraries to be linked against (those should be set using the appropriate find macros provided by cmake or by TNG - located in /cmake_subroutines),
enables the test environment
enables the Doxygen documentation
adds local targets for its library, for its tests and documentation and adds these targets as dependencies to the main make targets "doc", "lib" and "test".

Adding a driver

Drivers are executables which provide individual implementations of the TNG modules. Popular drivers are

a Lua interpreter working in batch mode and providing bindings to most modules,
a Lua interpreter providing a simple GUI and providing bindings to modules including GUI methods.

A driver must be added to the drivers directory with the following directory structure:

/drivers/name is the module main directory
/drivers/name/CMakeLists.txt describes the cmake instructions for this module
/drivers/name/name should contain all C++, C, Fortran source files
/drivers/name/doc/src/Doxyfile.in is the template for Doxyfile generated by cmake and used for compiling the API documentation. It usually does not differ from /doc/src/Doxyfile.in
/drivers/name/doc/src/mainpage.dox should at least contain a link to the parent documentation
/drivers/name/doc/src/ should contain further input files used by doxygen

Any driver must be announced to configuration files in the upper levels. In /drivers/CMakeLists.txt one has to add the new driver to the list of drivers and one has to set its dependencies, but only the dependencies onto other modules. Dependencies on external libraries must be defined in the own CMakeLists.txt.

The usual CMakeLists.txt

defines a list of directories where all source files are automatically fetched from,
defines a list of test drivers (each test driver should be a single file which is passed as a command line argument to the executable),
defines a list of include directories and libraries to be linked against (those should be set using the appropriate find macros provided by cmake or by TNG - located in /cmake_subroutines),
enables the test environment
enables the Doxygen documentation
adds local targets for its library, for its tests and documentation and adds these targets as dependencies to the main make targets "doc", "lib" and "test".

CMake

Compiling TNG

Adding a module

Adding a driver

Links