Building model

This page is under construction

How to build using build.sh from the top-level directory (ie, ufs-weather-model)

• build.sh is a simple wrapper that calls CMake build system

1) load the required modules

  module use modulefiles/<machine>.<compiler> (i.e. orion.intel, hera.intel, hera.gnu)
  module load fv3 (or fv3_debug)

• NOTE: On platform GAEA, you must first set up the lmod environment:

   source /lustre/f2/pdata/esrl/gsd/contrib/lua-5.1.4.9/init/init_lmod.sh

2) Build command, one line or multi-line

• export before the call to build.sh, for example:

  export CMAKE_FLAGS="-DS2S=ON -DDATM=ON"
  export CCPP_SUITES="FV3_GFS_2017_coupled,FV3_GFS_v15p2_coupled"
  ./build.sh

• build using one-line command, several examples:

Build the ufs-weather model in S2S mode (coupled to ice/ocean):

    CMAKE_FLAGS="-DS2S=ON" CCPP_SUITES="FV3_GFS_2017_coupled,FV3_GFS_v15p2_coupled" ./build.sh > output 2>&1 &

Build the ufs-weather model in S2S mode (coupled to ice/ocean) with debugging flags turned on, with verbose build messages, using a single build job and a specified build directory:

   CMAKE_FLAGS="-DS2S=ON -DDEBUG=ON" CCPP_SUITES="FV3_GFS_2017_coupled,FV3_GFS_2017_satmedmf_coupled,FV3_GFS_v15p2_coupled" BUILD_VERBOSE=1 BUILD_JOBS=1 
   BUILD_DIR=test_cpld ./build.sh > output 2>&1 &

Build the ufs-model in S2S mode including the wave model (WW3):

   CMAKE_FLAGS="-DS2S=ON, WW3=ON" CCPP_SUITES="FV3_GFS_2017_coupled,FV3_GFS_2017_satmedmf_coupled,FV3_GFS_v15p2_coupled,FV3_GFS_v16beta_coupled" ./build.sh >output 2>&1 &

In each case, the executable will be build/ufs_model

If you edit source code files, just run the same command again. CMake does not need to be cleaned (as much).

compile.sh

• File location is ufs-weather-model/tests
• Sets up environment variables and calls build.sh
• Used by ufs-weather-model/tests/rt.sh

How to feed build options to compile.sh

• For examples, see the second column of rows that start with COMPILE in ufs-weather-model/tests/rt.conf
• Specify components to build, e.g.,
  • S2S=Y (include MOM6, CICE, CMEPS)
  • WW3=Y
• Specify CCPP suite name, e.g.,
  • CCPP=Y SUITES=FV3_GFS_2017
  • CCPP=Y SUITES=FV3_GFS_2017_coupled
• Build in debug mode
  • DEBUG=Y
• Putting everything together, e.g.,
  • CCPP=Y SUITES=FV3_GFS_2017_coupled S2S=Y WW3=Y