Build Status

GOTM is relative easy to install and run on most operating systems - just follow the instructions carefully.

Begin change as of 2019-06-14

On 2019-06-14 we have updated the CMake configuration files to be in accordance with the concept of Modern CMake. This has the implication that the build instructions have to be slightly modified - and simplified.

The main change between the old and new configuration is the use of submodules. Submodules makes it possible to use git to knit together different software components to form a whole. The individual components can be developed in their respective projects and only updated in GOTM when ready for prime time.

From a user point of view this implies the following changes when working with the code (here we show the changed operation when using the command line - graphical frontends to git will allow for similar operations):

GOTM new clone:

git clone --recursive
git submodule update --init --recursive

GOTM already cloned:

git submodule update --init --recursive

GOTM pull:

git pull --recurse-submodules

For some time we will keep the original instructions in strikeout but new users should follow the updated instructions.

End change as of 2019-06-14

  1. The source code for GOTM and FABM must have been cloned from the Git repositories - GOTM must be cloned and FABM - respectively. The actual cloning will depend on the platform and Git-utilities used. Further information is provide here. A number of graphical frontends to Git are available - but the use of these is beyond the instructions provided here.
  2. A Fortran compiler supporting at least Fortran 2003 must be avaialble
  3. NetCDF
    • On Linux/Mac GOTM and NetCDF must be compiled with the same Fortran compiler. The configuration and compilation of the NetCDF library is beyond the purpose of this guide.
    • On Windows NetCDF is provided in the repository - compatible with the Intel Fortran compiler
  4. CMake must be installed. CMake is used to configure the compilation and generate native build systems - i.e. Make-based systems on Linux/Mac and VisualStudio on Windows. CMake can be run in command-line and GUI-mode. Further information is provided here. A detailed description is beyond the purpose of this guide. CMake advocates out of source compilation i.e. the actual compilation is separated from the source code. To facilitate this the use of a temporary build directory is encouraged.

Only when the above 4 points are checked it makes sense to proceed.

The GOTM executable can be configured in a number of ways depending on the intended use. This configuration is controlled by CMake - and its configuration file provided as part of the GOTM source code. The different configuration options have sensible default values so a fully functional executable can be obtained with very little configuration. On the other hand detailed control of included features, installation path etc. is also possible.