rrfs_ci: Updates from develop.

.cicd/Jenkinsfile

@@ -7,8 +7,8 @@ pipeline {
 
     parameters {
         // Allow job runner to filter based on platform
-        // choice(name: 'SRW_PLATFORM_FILTER', choices: ['all', 'cheyenne', 'gaea', 'orion', 'pcluster_noaa_v2_use1', 'azcluster_noaa', 'gcluster_noaa_v2_usc1'], description: 'Specify the platform(s) to use')
-        choice(name: 'SRW_PLATFORM_FILTER', choices: ['all', 'cheyenne', 'gaea', 'orion'], description: 'Specify the platform(s) to use')
+        // choice(name: 'SRW_PLATFORM_FILTER', choices: ['all', 'cheyenne', 'gaea', 'hera', 'jet', 'orion', 'pcluster_noaa_v2_use1', 'azcluster_noaa', 'gcluster_noaa_v2_usc1'], description: 'Specify the platform(s) to use')
+        choice(name: 'SRW_PLATFORM_FILTER', choices: ['all', 'cheyenne', 'gaea', 'hera', 'jet', 'orion'], description: 'Specify the platform(s) to use')
         // Allow job runner to filter based on compiler
         choice(name: 'SRW_COMPILER_FILTER', choices: ['all', 'gnu', 'intel'], description: 'Specify the compiler(s) to use to build')
     }
@@ -68,8 +68,8 @@ pipeline {
                 axes {
                     axis {
                         name 'SRW_PLATFORM'
-                        // values 'cheyenne', 'gaea', 'orion', 'pcluster_noaa_v2_use1', 'azcluster_noaa', 'gcluster_noaa_v2_usc1'
-                        values 'cheyenne', 'gaea', 'orion'
+                        // values 'cheyenne', 'gaea', 'hera', 'jet', 'orion', 'pcluster_noaa_v2_use1', 'azcluster_noaa', 'gcluster_noaa_v2_usc1'
+                        values 'cheyenne', 'gaea', 'hera', 'jet', 'orion'
                     }
 
                     axis {
@@ -83,7 +83,7 @@ pipeline {
                     exclude {
                             axis {
                             name 'SRW_PLATFORM'
-                            values 'gaea', 'orion'
+                            values 'gaea', 'hera', 'jet', 'orion'
                         }
 
                         axis {
@@ -98,7 +98,8 @@ pipeline {
                 }
 
                 environment {
-                    BUILD_VERSION = "${env.SRW_PLATFORM}-${env.SRW_COMPILER}-${env.BRANCH_NAME}-${env.BUILD_NUMBER}"
+                    BRANCH_NAME_ESCAPED = env.BRANCH_NAME.replace('/', '_')
+                    BUILD_VERSION = "${env.SRW_PLATFORM}-${env.SRW_COMPILER}-${env.BRANCH_NAME_ESCAPED}-${env.BUILD_NUMBER}"
                     BUILD_NAME = "ufs-srweather-app_${env.BUILD_VERSION}"
                 }
 

.cicd/scripts/srw_build.sh

@@ -26,6 +26,6 @@ module load "build_${SRW_PLATFORM}_${SRW_COMPILER}"
 # Compile SRW application and install to repository root.
 mkdir "${build_dir}"
 pushd "${build_dir}"
-    cmake -DCMAKE_INSTALL_PREFIX="${workspace}" "${workspace}"
+    cmake -DCMAKE_INSTALL_PREFIX="${workspace}" -DENABLE_RRFS=on "${workspace}"
     make -j "${MAKE_JOBS}"
 popd

.github/workflows/build.yml

@@ -0,0 +1,21 @@
+name: Build SRW
+on: [push]
+jobs:
+  Explore-GitHub-Actions:
+    runs-on: [self-hosted, ncar]
+    steps:
+      - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
+      - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
+      - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
+      - name: Check out repository code
+        uses: actions/checkout@v2
+      - run: |
+             cd ufs-srweather-app
+             ./manage_externals/checkout_externals
+             module use modulefiles
+             module load build_cheyenne_intel
+             mdkir build
+             cd build
+             cmake -DCMAKE_INSTALL_PREFIX=.. ..
+             make -j 4
+      - run: echo "🍏 This job's status is ${{ job.status }}."

CMakeLists.txt

@@ -45,6 +45,9 @@ FUNCTION(is_enabled feature ret_val)
   ENDIF(${feature})
 ENDFUNCTION()
 
+# User options
+option(ENABLE_RRFS "Build RRFS components" OFF)
+
 # Turn on testing.
 enable_testing()
 include(CTest)

Externals.cfg

@@ -20,7 +20,7 @@ protocol = git
 repo_url = https://github.com/ufs-community/ufs-weather-model
 # Specify either a branch name or a hash but not both.
 #branch = develop
-hash = 96dffa1
+hash = 830b507
 local_path = src/ufs-weather-model
 required = True
 
@@ -29,9 +29,28 @@ protocol = git
 repo_url = https://github.com/NOAA-EMC/UPP
 # Specify either a branch name or a hash but not both.
 #branch = develop
-hash = 394917e
+hash = fbd41a5
 local_path = src/UPP
 required = True
 
+[GSI]
+protocol = git
+repo_url = https://github.com/NOAA-EMC/GSI.git
+# Specify either a branch name or a hash but not both.
+#branch = develop
+hash = ad84f17
+local_path = src/gsi
+externals = None
+required = True
+
+[rrfs_utl]
+protocol = git
+repo_url = https://github.com/NOAA-GSL/rrfs_utl.git
+# Specify either a branch name or a hash but not both.
+#branch = develop
+hash = 8d21f25
+local_path = src/rrfs_utl
+required = True
+
 [externals_description]
 schema_version = 1.0.0

README.md

@@ -2,11 +2,11 @@
 
 The Unified Forecast System (UFS) is a community-based, coupled, comprehensive Earth modeling system. It is designed to be the source system for NOAA’s operational numerical weather prediction applications while enabling research, development, and contribution opportunities for the broader weather enterprise. For more information about the UFS, visit the UFS Portal at https://ufscommunity.org/.
 
-The UFS includes multiple applications (see a complete list at https://ufscommunity.org/science/aboutapps/) that support different forecast durations and spatial domains. This documentation describes the UFS Short-Range Weather (SRW) Application, which targets predictions of atmospheric behavior on a limited spatial domain and on time scales from minutes to several days. The development branch of the application is continually evolving as the system undergoes open development. The SRW App release branches represent a snapshot of this continuously evolving system. The SRW Application includes a prognostic atmospheric model, pre- and post-processing, and a community workflow for running the system end-to-end. These components are documented within the User's Guide and supported through a community forum (https://forums.ufscommunity.org/). 
+The UFS includes multiple applications (see a complete list at https://ufscommunity.org/science/aboutapps/) that support different forecast durations and spatial domains. This documentation describes the development branch of the UFS Short-Range Weather (SRW) Application, which targets predictions of atmospheric behavior on a limited spatial domain and on time scales from minutes to several days. The development branch of the application is continually evolving as the system undergoes open development. The latest SRW App release (v2.0.0) represents a snapshot of this continuously evolving system. 
 
-The UFS SRW App User's Guide associated with the development branch can be found at: https://ufs-srweather-app.readthedocs.io/en/develop/, while the guide specific to the SRW App v1.0.1 release can be found at: https://ufs-srweather-app.readthedocs.io/en/ufs-v1.0.1/. The GitHub repository link is: https://github.com/ufs-community/ufs-srweather-app.
+The UFS SRW App User's Guide associated with the development branch is at: https://ufs-srweather-app.readthedocs.io/en/develop/, while the guide specific to the SRW App v2.0.0 release can be found at: https://ufs-srweather-app.readthedocs.io/en/release-public-v2/. The repository is at: https://github.com/ufs-community/ufs-srweather-app.
 
 For instructions on how to clone the repository, build the code, and run the workflow, see:
 https://github.com/ufs-community/ufs-srweather-app/wiki/Getting-Started
 
-UFS Development Team. (2021, March 4). Unified Forecast System (UFS) Short-Range Weather (SRW) Application (Version v1.0.0). Zenodo. https://doi.org/10.5281/zenodo.4534994
+UFS Development Team. (2022, June 23). Unified Forecast System (UFS) Short-Range Weather (SRW) Application (Version v2.0.0). Zenodo. https://doi.org/10.5281/zenodo.6505854

devbuild.sh

@@ -10,15 +10,17 @@ OPTIONS
       show this help guide
   -p, --platform=PLATFORM
       name of machine you are building on
-      (e.g. cheyenne | hera | jet | orion | wcoss_dell_p3)
+      (e.g. cheyenne | hera | jet | orion | wcoss_dell_p3 | wcoss2)
   -c, --compiler=COMPILER
       compiler to use; default depends on platform
       (e.g. intel | gnu | cray | gccgfortran)
-  --app=APPLICATION
+  -a, --app=APPLICATION
       weather model application to build
       (e.g. ATM | ATMW | S2S | S2SW)
   --ccpp="CCPP_SUITE1,CCPP_SUITE2..."
-      CCCP suites to include in build; delimited with ','
+      CCPP suites (CCPP_SUITES) to include in build; delimited with ','
+  --rrfs
+      build rrfs system components: GSI, rrfs_utl
   --enable-options="OPTION1,OPTION2,..."
       enable ufs-weather-model options; delimited with ','
       (e.g. 32BIT | INLINE_POST | UFS_GOCART | MOM6 | CICE6 | WW3 | CMEPS)
@@ -52,13 +54,13 @@ settings () {
 cat << EOF_SETTINGS
 Settings:
 
-  SRC_DIR=${SRC_DIR}
+  SRW_DIR=${SRW_DIR}
   BUILD_DIR=${BUILD_DIR}
   INSTALL_DIR=${INSTALL_DIR}
   PLATFORM=${PLATFORM}
   COMPILER=${COMPILER}
   APP=${APPLICATION}
-  CCPP=${CCPP}
+  CCPP=${CCPP_SUITES}
   ENABLE_OPTIONS=${ENABLE_OPTIONS}
   DISABLE_OPTIONS=${DISABLE_OPTIONS}
   CLEAN=${CLEAN}
@@ -79,13 +81,14 @@ usage_error () {
 
 # default settings
 LCL_PID=$$
-SRC_DIR=$(cd "$(dirname "$(readlink -f -n "${BASH_SOURCE[0]}" )" )" && pwd -P)
-MACHINE_SETUP=${SRC_DIR}/src/UFS_UTILS/sorc/machine-setup.sh
-BUILD_DIR=${SRC_DIR}/build
-INSTALL_DIR=${SRC_DIR}
+SRW_DIR=$(cd "$(dirname "$(readlink -f -n "${BASH_SOURCE[0]}" )" )" && pwd -P)
+MACHINE_SETUP=${SRW_DIR}/src/UFS_UTILS/sorc/machine-setup.sh
+BUILD_DIR="${SRW_DIR}/build"
+INSTALL_DIR=${SRW_DIR}
 COMPILER=""
 APPLICATION=""
-CCPP=""
+CCPP_SUITES=""
+RRFS="off"
 ENABLE_OPTIONS=""
 DISABLE_OPTIONS=""
 BUILD_TYPE="RELEASE"
@@ -108,10 +111,12 @@ while :; do
     --platform|--platform=|-p|-p=) usage_error "$1 requires argument." ;;
     --compiler=?*|-c=?*) COMPILER=${1#*=} ;;
     --compiler|--compiler=|-c|-c=) usage_error "$1 requires argument." ;;
-    --app=?*) APPLICATION=${1#*=} ;;
-    --app|--app=) usage_error "$1 requires argument." ;;
-    --ccpp=?*) CCPP=${1#*=} ;;
+    --app=?*|-a=?*) APPLICATION=${1#*=} ;;
+    --app|--app=|-a|-a=) usage_error "$1 requires argument." ;;
+    --ccpp=?*) CCPP_SUITES=${1#*=} ;;
     --ccpp|--ccpp=) usage_error "$1 requires argument." ;;
+    --rrfs) RRFS="on" ;;
+    --rrfs=*) usage_error "$1 argument ignored." ;;
     --enable-options=?*) ENABLE_OPTIONS=${1#*=} ;;
     --enable-options|--enable-options=) usage_error "$1 requires argument." ;;
     --disable-options=?*) DISABLE_OPTIONS=${1#*=} ;;
@@ -136,6 +141,11 @@ while :; do
   shift
 done
 
+# Ensure uppercase / lowercase ============================================
+APPLICATION="${APPLICATION^^}"
+PLATFORM="${PLATFORM,,}"
+COMPILER="${COMPILER,,}"
+
 # check if PLATFORM is set
 if [ -z $PLATFORM ] ; then
   printf "\nERROR: Please set PLATFORM.\n\n"
@@ -155,9 +165,10 @@ if [ -z "${COMPILER}" ] ; then
     jet|hera|gaea) COMPILER=intel ;;
     orion) COMPILER=intel ;;
     wcoss_dell_p3) COMPILER=intel ;;
+    wcoss2) COMPILER=intel ;;
     cheyenne) COMPILER=intel ;;
     macos,singularity) COMPILER=gnu ;;
-    odin) COMPILER=intel ;;
+    odin,noaacloud) COMPILER=intel ;;
     *)
       COMPILER=intel
       printf "WARNING: Setting default COMPILER=intel for new platform ${PLATFORM}\n" >&2;
@@ -174,7 +185,7 @@ fi
 
 # set MODULE_FILE for this platform/compiler combination
 MODULE_FILE="build_${PLATFORM}_${COMPILER}"
-if [ ! -f "${SRC_DIR}/modulefiles/${MODULE_FILE}" ]; then
+if [ ! -f "${SRW_DIR}/modulefiles/${MODULE_FILE}" ]; then
   printf "ERROR: module file does not exist for platform/compiler\n" >&2
   printf "  MODULE_FILE=${MODULE_FILE}\n" >&2
   printf "  PLATFORM=${PLATFORM}\n" >&2
@@ -226,8 +237,11 @@ CMAKE_SETTINGS="${CMAKE_SETTINGS} -DCMAKE_BUILD_TYPE=${BUILD_TYPE}"
 if [ ! -z "${APPLICATION}" ]; then
   CMAKE_SETTINGS="${CMAKE_SETTINGS} -DAPP=${APPLICATION}"
 fi
-if [ ! -z "${CCPP}" ]; then
-  CMAKE_SETTINGS="${CMAKE_SETTINGS} -DCCPP=${CCPP}"
+if [ ! -z "${CCPP_SUITES}" ]; then
+  CMAKE_SETTINGS="${CMAKE_SETTINGS} -DCCPP_SUITES=${CCPP_SUITES}"
+fi
+if [ ! -z "${RRFS}" ]; then
+  CMAKE_SETTINGS="${CMAKE_SETTINGS} -DENABLE_RRFS=${RRFS}"
 fi
 if [ ! -z "${ENABLE_OPTIONS}" ]; then
   CMAKE_SETTINGS="${CMAKE_SETTINGS} -DENABLE_OPTIONS=${ENABLE_OPTIONS}"
@@ -243,17 +257,17 @@ if [ "${VERBOSE}" = true ]; then
 fi
 
 # Before we go on load modules, we first need to activate Lmod for some systems
-source ${SRC_DIR}/etc/lmod-setup.sh
+source ${SRW_DIR}/etc/lmod-setup.sh $MACHINE
 
 # source the module file for this platform/compiler combination, then build the code
 printf "... Load MODULE_FILE and create BUILD directory ...\n"
-module use ${SRC_DIR}/modulefiles
+module use ${SRW_DIR}/modulefiles
 module load ${MODULE_FILE}
 module list
 mkdir -p ${BUILD_DIR}
 cd ${BUILD_DIR}
 printf "... Generate CMAKE configuration ...\n"
-cmake ${SRC_DIR} ${CMAKE_SETTINGS} 2>&1 | tee log.cmake
+cmake ${SRW_DIR} ${CMAKE_SETTINGS} 2>&1 | tee log.cmake
 printf "... Compile executables ...\n"
 make ${MAKE_SETTINGS} 2>&1 | tee log.make
 

docs/INSTALL

@@ -42,7 +42,7 @@ source etc/lmod-setup.sh PLATFORM
 # From here on, we can assume Lmod is loaded and ready to go. Then we load the specific
 # module for a given PLATFORM and COMPILER as follows
 
-module use modulefiles
+module use $PWD/modulefiles   #full path to modulefiles directory
 module load build_[PLATFORM]_[COMPILER]
 
 # Supported CMake flags: