Versions Compared

Old Version 1

changes.mady.by.user Unknown User (mak)

Saved on

compared with

New Version Current

changes.mady.by.user Stephan Siemen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

CMake is a cross-platform free software program for managing the build process of software using a compiler-independent method.

Generating the Makefiles with CMake

One nice and highly recommended feature of CMake is the ability to do out of source builds. In this way you can make all your ".o" files, various temporary depend files, and even the binary executables without cluttering up your source tree. To use out of source builds, first create a build directory, then change into your build directory and run cmake pointing it to the source directory and using your own options.

The command gives feedback on what requirements are fulfilled and what software is still required. The following table gives an overview of the different options.  The default (without any options) will compile a shared library only and install it in /usr/local/.

 

CMAKE_INSTALL_PREFIXwhere you want to install your ODB API/usr/local
CMAKE_BUILD_TYPE

to select the type of compilation:

  • Debug
  • RelWithDebInfo
  • Release
  • Production
RelWithDebInfo
BUILD_SHARED_LIBSSelect the type of library built:
  • ON (Build shared libraries only)
  • OFF (Build static libraries only)
  • BOTH (Build both shared and static libraries)
ON
CMAKE_CXX_COMPILERC++ compiler 
CMAKE_CXX_FLAGSFlags for the C++ compiler 
CMAKE_C_COMPILERC
Compiler
compiler 
CMAKE_C_FLAGSFlags for the C
Compiler
compiler 
CMAKE_Fortran_COMPILERFortran
Compiler
compiler 
CMAKE_Fortran_FLAGSFlags for the Fortran
Compiler
compiler 
ENABLE_NETCDF
For the grib_to_netcdf convert
Build odb2netcdf toolAUTO
ENABLE_
JPGEnable JPEG2000 support. This option should look for Jasper or OpenJPG

AUTO

PYTHONBuild Python interface for ODB API
ENABLE_PNGEnable PNG support for decoding/encodingOFFENABLE_PYTHONOffers the Python interface to the package
AUTO
ENABLE_FORTRAN
Offers the
Build Fortran interface
to the package
for ODB APIAUTO
ENABLE_
ECCODES_THREADSEnable POSIX threadsOFFENABLE_ECCODES_OMP_THREADSEnable OpenMP threadsOFFENABLE_MEMFSSee Memory based access to definition/sample files
MIGRATORBuild odb_migrator tool for importing legacy ODB databases 
ODB_SOURCEDirectory with source of the legacy ODB software 
ODB_PATHPath to legacy ODB installation 
OFF
cmake options
doc
default


Note: The compilers can also be overridden by setting the environment variables CC and FC.

Note: To see the full output from the compilation, you can use:   make

Code Block
languagebash
titleBuild in verbose mode
$ make VERBOSE=
1
1  

Quick installation guide

Here is an example of a list of commands are example commands that you could use to install ODB API.   It is assumed “>” is the Dollar sign ($) is a typical shell prompt.

Code Block
languagebash
titleBasic installation procedure
$> tar -xzf  ODB_API-x.y.z-Source.tar.gz
>$ mkdir build ; cd build 

>$ cmake -DCMAKE_INSTALL_PREFIX=/path/to/where/you/install/odb_api ../ODB_API-x.y.z-Source 
...

>$ make
>$ ctest
>$ make install


It is recommended that you always build in a clean directory and also install into a clean directory.

...