Replace bash env files with modules

devbuild.sh

@@ -3,7 +3,7 @@
 # usage instructions
 usage () {
 cat << EOF_USAGE
-Usage: $0 [OPTIONS]...
+Usage: $0 --platform=PLATFORM [OPTIONS]...
 
 OPTIONS
   -h, --help
@@ -93,8 +93,6 @@ BUILD_JOBS=4
 CLEAN=false
 CONTINUE=false
 VERBOSE=false
-# detect PLATFORM (MACHINE)
-source ${SRC_DIR}/env/detect_machine.sh
 
 # process required arguments
 if [[ ("$1" == "--help") || ("$1" == "-h") ]]; then
@@ -138,17 +136,32 @@ while :; do
   shift
 done
 
+# check if PLATFORM is set
+if [ -z $PLATFORM ] ; then
+  printf "\nERROR: Please set PLATFORM.\n\n"
+  usage
+  exit 0
+fi
+
+# set PLATFORM (MACHINE)
+MACHINE="${PLATFORM}"
+printf "PLATFORM(MACHINE)=${PLATFORM}\n" >&2
+
 set -eu
 
 # automatically determine compiler
 if [ -z "${COMPILER}" ] ; then
   case ${PLATFORM} in
-    jet|hera) COMPILER=intel ;;
+    jet|hera|gaea) COMPILER=intel ;;
     orion) COMPILER=intel ;;
     wcoss_dell_p3) COMPILER=intel ;;
     cheyenne) COMPILER=intel ;;
-    macos) COMPILER=gccgfortran ;;
-    *) printf "ERROR: Unknown platform ${PLATFORM}\n" >&2; usage >&2; exit 1 ;;
+    macos,singularity) COMPILER=gnu ;;
+    odin) COMPILER=intel ;;
+    *)
+      COMPILER=intel
+      printf "WARNING: Setting default COMPILER=intel for new platform ${PLATFORM}\n" >&2;
+      ;;
   esac
 fi
 
@@ -159,18 +172,19 @@ if [ "${VERBOSE}" = true ] ; then
   settings
 fi
 
-# set ENV_FILE for this platform/compiler combination
-ENV_FILE="${SRC_DIR}/env/build_${PLATFORM}_${COMPILER}.env"
-if [ ! -f "${ENV_FILE}" ]; then
-  printf "ERROR: environment file does not exist for platform/compiler\n" >&2
-  printf "  ENV_FILE=${ENV_FILE}\n" >&2
+# set MODULE_FILE for this platform/compiler combination
+MODULE_FILE="build_${PLATFORM}_${COMPILER}"
+if [ ! -f "${SRC_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
   printf "  COMPILER=${COMPILER}\n\n" >&2
+  printf "Please make sure PLATFORM and COMPILER are set correctly\n" >&2
   usage >&2
   exit 64
 fi
 
-printf "ENV_FILE=${ENV_FILE}\n" >&2
+printf "MODULE_FILE=${MODULE_FILE}\n" >&2
 
 # if build directory already exists then exit
 if [ "${CLEAN}" = true ]; then
@@ -228,10 +242,13 @@ if [ "${VERBOSE}" = true ]; then
   MAKE_SETTINGS="${MAKE_SETTINGS} VERBOSE=1"
 fi
 
-# source the environment file for this platform/compiler combination, then build the code
-printf "... Source ENV_FILE and create BUILD directory ...\n"
-module use ${SRC_DIR}/env
-. ${ENV_FILE}
+# Before we go on load modules, we first need to activate Lmod for some systems
+source ${SRC_DIR}/lmod-setup.sh
+
+# 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 load ${MODULE_FILE}
 module list
 mkdir -p ${BUILD_DIR}
 cd ${BUILD_DIR}

docs/INSTALL

@@ -12,10 +12,35 @@ git clone https://github.com/ufs-community/ufs-srweather-app.git
 cd ufs-srweather-app/
 ./manage_externals/checkout_externals
 
-# Prior to building, you must set up the environment so cmake can find the appropriate compilers
-# and libraries. For instructions specific to supported platforms, see the "build_[machine]_[compiler].env 
-# files in the "env" directory. These files give instructions assuming a bash or ksh login shell, for
-# csh and tcsh users you will have to modify the commands for setting envronment variables.
+# We can build ufs-sreweather-app binaries in two ways.
+
+# Method 1
+# ========
+
+# This is the simplest way to build the binaries
+
+./devbuild.sh --platform=PLATFORM
+
+# If compiler auto-detection fails, specify it using
+
+./devbuild.sh --platform=PLATFORM --compiler=COMPILER
+
+# Method 2
+# ========
+
+# The above instructions will work atleast on Tier-1 systems, if not on all supported machines.
+# However, if it fails for some reason, we can build directly with cmake.
+# First we need to make sure that there is a modulefile "build_[PLATFORM]_[COMPILER]" in the
+# "modulefiles" directory. Also, on some systems (e.g. Gaea/Odin) that come with cray module system,
+# we need to swap it for Lmod instead. Assuming the login shell is bash
+
+source ./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 load build_[PLATFORM]_[COMPILER]
 
 # Supported CMake flags:
 #  -DCMAKE_INSTALL_PREFIX Location where the bin/ include/ lib/ and share/ directories containing

docs/RUNTIME

@@ -1,13 +1,22 @@
 # Users should load the appropriate python environment for the workflow. 
 # The workflow requires Python 3, with the packages 'PyYAML', 'Jinja2', and 'f90nml' available.
 
-# For users' convenience, the python environment for the workflow is put in 'ufs-srweather-app/env/wflow_[machine].env'.
-# When generating a workflow experiment or running a workflow, users can use this file for a specific machine.
+# For users' convenience, the python environment for the workflow can be activated by loading wflow_[PLATFORM] modulefile
 
 # For example, on Hera:
 
-cd ufs-srweather-app/env
-source wflow_hera.env
+module load wflow_hera
+
+# Due to older version of Lmod, inconsistency with TCL modulefiles etc, you may have to activate
+# conda manually using instructions that the previous module command prints.
+# Hera is one of those systems, so execute:
+
+conda activate regional_workflow
+
+# After that we can setup an experiment in the directory
+
+cd regional_workflow/ush
+
+# Once we prepare experiment file config.sh, we can generate workflow using
 
-cd ../regional_workflow/ush
 ./generate_FV3LAM_wflow.sh