BUILD_LIB_FILE

Each library will need to provide a buildlib to configure and build the library.

Entry

The following is an exmple entry for BUILD_LIB_FILE in config_files.xml.

Each value corresponds to a library that can be built. The lib attribute is the name of the library and the value is the path to the buildlib script.

<entry id="BUILD_LIB_FILE">
    <type>char</type>
    <values>
    <value lib="kokkos">$SRCROOT/share/build/buildlib.kokkos</value>
    <value lib="gptl">$SRCROOT/share/build/buildlib.gptl</value>
    <value lib="pio">$CIMEROOT/CIME/build_scripts/buildlib.pio</value>
    <value lib="spio">$SRCROOT/share/build/buildlib.spio</value>
    <value lib="mct">$SRCROOT/share/build/buildlib.mct</value>
    <value lib="csm_share">$SRCROOT/share/build/buildlib.csm_share</value>
    <value lib="mpi-serial">$SRCROOT/share/build/buildlib.mpi-serial</value>
    <value lib="cprnc">$CIMEROOT/CIME/build_scripts/buildlib.cprnc</value>
    </values>
    <group>case_last</group>
    <file>env_case.xml</file>
    <desc> path to buildlib script for the given library </desc>
</entry>

Build library

Implementing a buildlib for a component is as simple as creating a python file and defining a single function; buildlib.

Below are the arguments for the buildlib function.

Parameter	Description
bldroot	The root directory to build the library.
installpath	The directory to install the library.
case	This is a CIME.case.case.Case object.

Use this function to setup, build the library and run any post-processing after the build.

Note

It’s best to start by copying a buildlib from another component for a stating point.

Example

import glob

from CIME.utils import copyifnewer, run_bld_cmd_ensure_logging
from CIME.build import get_standard_cmake_args

def buildlib(bldroot, installpath, case):
    paths = glob.glob(...)

    for x in paths:
    copyifnewer(x, os.path.join(...))

    libdir = os.path.join(...)

    cmake_args = get_standard_cmake_args(case, installpath)

    run_bld_cmd_ensure_logging(f"cmake {cmake_args}", logger, from_dir=libdir)