Cmake Fortran Scripts

Cmake scripts for Fortran Projects at CHS

Cmake Modules

These modules provide different functions and macros to be used in CMakeLists.txt files.

To use a module, you either need to update the cmake module path (assuming these files are in a top-level folder called cmake/):

list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)

and then include the module by name, e.g.:

include(CPM)

or include the module directly by path (relative to the CMakeLists.txt file)

include(cmake/CPM.cmake)

For package finders (e.g. YAC or NetCDF) you need to update the cmake module path.

fortranpreprocessor.cmake

Draws inspiration from https://github.com/fortran-lang/stdlib/blob/master/cmake/stdlib.cmake (MIT license) to handle fypp pre-processor.

Additional functions:

• get_preproc_flag: checks for the pre-processor flag of the current compiler (-fpp or -cpp)
• cpp_definitions: adds a compile definition and a corresponding cmake option

Can be included with:

include(fortranpreprocessor)

CodeCoverage.cmake

Copied from: https://github.com/bilke/cmake-modules/blob/master/CodeCoverage.cmake (Copyright Lars Bilke, BSL 1.0 license, see file)

Can be included and set up with:

include(CodeCoverage)
append_coverage_compiler_flags_to_target(PROJECT)
SETUP_TARGET_FOR_COVERAGE_LCOV(
  NAME PROJECT_coverage_CI
  EXECUTABLE PROJECT
  DEPENDENCIES PROJECT
  GENHTML_ARGS -t "PROJECT coverage"
)

compileoptions.cmake

Adds cmake compile options

• CMAKE_BUILD_MODULE_SYSTEM_INDEPENDENT: setting r_path
• CMAKE_WITH_MPI: use MPI
• CMAKE_WITH_OpenMP: use OpenMP
• CMAKE_WITH_LAPACK: use LAPACK bindings
• CMAKE_WITH_COVERAGE: Coverage calculation
• CMAKE_WITH_GPROF: gprof profiling information (see here for tutorial)
• will also search for MPI, OpenMP and LAPACK if the respective option is ON

Can be included with:

include(compileoptions)

FindPackageWrapper.cmake

FindPackage scripts from a the cmake module path can differe in child projects and my work differently. To use a local cmake module path to find a package for you cmake project you can use the provided macro. This macro will temporarily reset the module path to the given one, call find_package with the provided arguments and then reset the module path.

Can be used like:

include(FindPackageWrapper.cmake)
find_package_wrapper(${YOUR_MODULE_PATH} NetCDF COMPONENTS Fortran QUIET)

FindNetCDF.cmake

Can be used like:

find_package(NetCDF COMPONENTS Fortran)
target_link_libraries(<target> PUBLIC NetCDF::NetCDF_Fortran)

To specify a particular NetCDF library, use

cmake -DNetCDF_ROOT=/path/to/netcdff -B build

or set environment variable NetCDF_ROOT=/path/to/netcdff.

FindYAC.cmake

Can be used like:

find_package(YAC)
target_include_directories(<target> PUBLIC ${YAC_INCLUDE_DIR})
target_link_libraries(<target> PUBLIC ${YAC_LIB})

To specify a particular NetCDF library, use

cmake -DYAC_ROOT=/path/to/yac -B build

or set environment variable YAC_ROOT=/path/to/yac.

FindESMF.cmake

Copied from: https://github.com/esmf-org/esmf/blob/v8.5.0/cmake/FindESMF.cmake (Copyright (c) 2002-2023 University Corporation for Atmospheric Research, Massachusetts Institute of Technology, Geophysical Fluid Dynamics Laboratory, University of Michigan, National Centers for Environmental Prediction, Los Alamos National Laboratory, Argonne National Laboratory, NASA Goddard Space Flight Center. All rights reserved., NCSA license, see file)

Uses ESMFMKFILE to find the filepath of esmf.mk. If this is NOT set, then this module will attempt to find esmf.mk. If ESMFMKFILE exists, then ESMF_FOUND=TRUE and all ESMF makefile variables will be set in the global scope. Optionally, set ESMF_MKGLOBALS to a string list to filter makefile variables. For example, to globally scope only ESMF_LIBSDIR and ESMF_APPSDIR variables, use this CMake command in CMakeLists.txt:

set(ESMF_MKGLOBALS "LIBSDIR" "APPSDIR")

Set ESMFMKFILE as defined by system env variable. If it's not explicitly set try to find esmf.mk file in default locations (ESMF_ROOT, CMAKE_PREFIX_PATH, etc)

Can be used like:

find_package(ESMF REQUIRED)
target_link_libraries(<target> PUBLIC ESMF)

version.cmake

Provides a function to read version and date from given files version.txt and (optional) version_date.txt.

Can be included and used with (PROJECT_VER_DEV will hold the develop version string):

include(version)
get_version(PROJECT_VER PROJECT_VER_DEV PROJECT_DATE)

If a development version was found (e.g. 1.0.0-dev0), it will try to determine the latest git commit short hash and add it (e.g. 1.0.0-dev0+02d7e12). If there is no version_date.txt file or a development version was found, the script will try to determine the latest git commit date or use the current date. PROJECT_VER will hold the simple version to be used with cmakes project command (e.g. 1.0.0). A prefixed v in the version will be ignored.

CPM.cmake (v0.40.2)

Copied from: https://github.com/cpm-cmake/CPM.cmake (Copyright Lars Melchior and contributors, MIT license, see file)

CPM.cmake is a CMake script that adds dependency management capabilities to CMake. It's built as a thin wrapper around CMake's FetchContent module that adds version control, caching, a simple API and more.

Can be used like:

include(CPM)
CPMAddPackage("https://git.ufz.de/chs/forces.git@0.3.2")
target_link_libraries(<project> PUBLIC forces)

Adding to your project

In order to add these files to your project, you can either just copy the desired files or use git-subrepo to add this repository as a folder:

git subrepo clone --branch=main --force https://git.ufz.de/chs/cmake-fortran-scripts.git cmake

You should replace main with a specific tag (like v1.8) to use a released version.

License

MIT License (MIT)

Copyright (c) 2020 - 2024 CHS Developers