Rename dirs and make executable dir switchable to meet NCO standards

CMakeLists.txt

@@ -49,9 +49,6 @@ ENDFUNCTION()
 enable_testing()
 include(CTest)
 
-# Build in this subdirectory.
-#add_subdirectory(src)
-
 #####
 # Configure and print the ufs-srweather-app.settings file.
 #####
@@ -91,6 +88,10 @@ SET(host_os "${osrel}")
 SET(abs_top_builddir "${CMAKE_CURRENT_BINARY_DIR}")
 SET(abs_top_srcdir "${CMAKE_CURRENT_SOURCE_DIR}")
 
+##### Executable directory name (exec_bin): exec or bin #############
+SET(exec_bin exec)
+#####################################################################
+
 SET(CC_VERSION "${CMAKE_C_COMPILER}")
 
 # Set values for .settings file.
@@ -119,7 +120,7 @@ MESSAGE(${UFS-SRWEATHER-APP_SETTINGS})
 # Install ufs_srweather_app.settings file into same location
 # as the app.
 INSTALL(FILES "${CMAKE_BINARY_DIR}/ufs_srweather_app.settings"
-  DESTINATION bin)
+  DESTINATION ${exec_bin})
 
 #####
 # Create 'ufs_srweather_app_meta.h' include file.
@@ -130,4 +131,4 @@ configure_file(
 
 FILE(COPY "${CMAKE_CURRENT_BINARY_DIR}/ufs_srweather_app_meta.h" DESTINATION include)
 
-add_subdirectory(src)
+add_subdirectory(sorc)

Externals.cfg

@@ -1,9 +1,11 @@
 [regional_workflow]
 protocol = git
-repo_url = https://github.com/ufs-community/regional_workflow
+#repo_url = https://github.com/ufs-community/regional_workflow
+repo_url = https://github.com/chan-hoo/regional_workflow
 # Specify either a branch name or a hash but not both.
 #branch = develop
-hash = e5d5c38
+branch = feature/move_wflow_env
+#hash = e5d5c38
 local_path = regional_workflow
 required = True
 
@@ -13,7 +15,7 @@ repo_url = https://github.com/ufs-community/UFS_UTILS
 # Specify either a branch name or a hash but not both.
 #branch = develop
 hash = f30740e
-local_path = src/UFS_UTILS
+local_path = sorc/UFS_UTILS
 required = True
 
 [ufs-weather-model]
@@ -22,16 +24,18 @@ repo_url = https://github.com/ufs-community/ufs-weather-model
 # Specify either a branch name or a hash but not both.
 #branch = develop
 hash = 805421d
-local_path = src/ufs-weather-model
+local_path = sorc/ufs-weather-model
 required = True
 
 [UPP]
 protocol = git
-repo_url = https://github.com/NOAA-EMC/UPP
+#repo_url = https://github.com/NOAA-EMC/UPP
+repo_url = https://github.com/chan-hoo/UPP
 # Specify either a branch name or a hash but not both.
 #branch = develop
-hash = 4a16052
-local_path = src/UPP
+branch = feature/exec_bin
+#hash = 4a16052
+local_path = sorc/UPP
 required = True
 
 [externals_description]

devbuild.sh

@@ -80,7 +80,7 @@ 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
+MACHINE_SETUP=${SRC_DIR}/sorc/UFS_UTILS/sorc/machine-setup.sh
 BUILD_DIR=${SRC_DIR}/build
 INSTALL_DIR=${SRC_DIR}
 COMPILER=""
@@ -89,12 +89,12 @@ CCPP=""
 ENABLE_OPTIONS=""
 DISABLE_OPTIONS=""
 BUILD_TYPE="RELEASE"
-BUILD_JOBS=4
+BUILD_JOBS=8
 CLEAN=false
 CONTINUE=false
 VERBOSE=false
 # detect PLATFORM (MACHINE)
-source ${SRC_DIR}/env/detect_machine.sh
+source ${SRC_DIR}/modulefiles/detect_machine.sh
 
 # process required arguments
 if [[ ("$1" == "--help") || ("$1" == "-h") ]]; then
@@ -161,7 +161,7 @@ if [ "${VERBOSE}" = true ] ; then
 fi
 
 # set ENV_FILE for this platform/compiler combination
-ENV_FILE="${SRC_DIR}/env/build_${PLATFORM}_${COMPILER}.env"
+ENV_FILE="${SRC_DIR}/modulefiles/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
@@ -231,7 +231,7 @@ 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
+module use ${SRC_DIR}/modulefiles
 . ${ENV_FILE}
 module list
 mkdir -p ${BUILD_DIR}

docs/UsersGuide/README → doc/UsersGuide/README

@@ -5,8 +5,8 @@ Steps to build and use the Sphinx documentation tool:
     https://sphinxcontrib-bibtex.readthedocs.io/en/latest/quickstart.html#installation
 
 2) Create a Sphinx documentation root directory:
-   % mkdir docs
-   % cd docs
+   % mkdir doc
+   % cd doc
 
 3) Initialize your Sphinx project (set up an initial directory structure) using
    % sphinx-quickstart

docs/UsersGuide/source/CodeReposAndDirs.rst → doc/UsersGuide/source/CodeReposAndDirs.rst

@@ -71,7 +71,7 @@ scripts are presented in parentheses.  Some directories have been removed for br
    ufs-srweather-app
    ├── (bin)
    ├── (build)
-   ├── docs  
+   ├── doc
    │     └── UsersGuide
    ├── (include)
    ├── (lib)
@@ -91,7 +91,7 @@ scripts are presented in parentheses.  Some directories have been removed for br
    │          ├── templates
    │          └── wrappers
    ├── (share)
-   └── src
+   └── sorc
         ├── UPP
         │     ├── parm
         │     └── sorc
@@ -122,7 +122,7 @@ contents of these sub-directories are described in :numref:`Table %s <Subdirecto
    +-------------------------+---------------------------------------------------------+
    | **Directory Name**      | **Description**                                         |
    +=========================+=========================================================+
-   | docs                    | Users' Guide Documentation                              |
+   | doc                     | Users' Guide Documentation                              |
    +-------------------------+---------------------------------------------------------+
    | jobs                    | J-job scripts launched by Rocoto                        |
    +-------------------------+---------------------------------------------------------+

src/CMakeLists.txt → sorc/CMakeLists.txt

@@ -1,13 +1,30 @@
 include(ExternalProject)
 
+##### CMAKE Arguments depending on exec_bin #########################
+
+if(${exec_bin} STREQUAL exec)
+  list(APPEND COMP_ARGS
+    "-DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}"
+    "-DEMC_EXEC_DIR=ON"
+  )
+else()
+  List(APPEND COMP_ARGS
+    "-DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}"
+  )
+endif()
+
+##### UFS_UTILS #####################################################
+
 ExternalProject_Add(UFS_UTILS
   PREFIX ${CMAKE_CURRENT_BINARY_DIR}/UFS_UTILS
   SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/UFS_UTILS
   INSTALL_DIR ${CMAKE_INSTALL_PREFIX}
-  CMAKE_ARGS "-DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}"
+  CMAKE_ARGS ${COMP_ARGS}
   BUILD_ALWAYS TRUE
   )
 
+##### ufs-weather-model #############################################
+
 if(NOT CCPP_SUITES)
   set(CCPP_SUITES "FV3_CPT_v0,FV3_GFS_2017_gfdlmp,FV3_GFS_2017_gfdlmp_regional,FV3_GSD_SAR,FV3_GSD_v0,FV3_GFS_v15p2,FV3_GFS_v16,FV3_RRFS_v1beta,FV3_HRRR,FV3_RRFS_v1alpha,FV3_GFS_v15_thompson_mynn_lam3km")
 endif()
@@ -58,14 +75,17 @@ ExternalProject_Add(ufs-weather-model
   SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/ufs-weather-model
   INSTALL_DIR ${CMAKE_INSTALL_PREFIX}
   CMAKE_ARGS ${UFS_WEATHER_MODEL_ARGS}
-  INSTALL_COMMAND mkdir -p ${CMAKE_INSTALL_PREFIX}/bin && cp ${CMAKE_CURRENT_BINARY_DIR}/ufs-weather-model/src/ufs-weather-model-build/ufs_model ${CMAKE_INSTALL_PREFIX}/bin/
+  INSTALL_COMMAND mkdir -p ${CMAKE_INSTALL_PREFIX}/${exec_bin} && cp ${CMAKE_CURRENT_BINARY_DIR}/ufs-weather-model/src/ufs-weather-model-build/ufs_model ${CMAKE_INSTALL_PREFIX}/${exec_bin}/
   BUILD_ALWAYS TRUE
   )
 
+##### UPP ########################################################### 
+
 ExternalProject_Add(UPP
   PREFIX ${CMAKE_CURRENT_BINARY_DIR}/UPP
   SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/UPP
   INSTALL_DIR ${CMAKE_INSTALL_PREFIX}
-  CMAKE_ARGS "-DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}"
+  CMAKE_ARGS ${COMP_ARGS}
   BUILD_ALWAYS TRUE
   )
+