Add optional data atmoshpere component

.gitmodules

@@ -34,3 +34,9 @@
   path = CICE-interface/CICE
   url = https://github.com/NOAA-EMC/CICE
   branch = emc/develop
+[submodule "DATM"]
+  path = DATM
+  #url = https://github.com/NOAA-EMC/NEMSdatm
+  #branch = develop
+  url = https://github.com/aerorahul/NEMSdatm
+  branch = feature/cmake

CMakeLists.txt

@@ -32,6 +32,7 @@ set(QUAD_PRECISION  ON  CACHE BOOL "Enable QUAD_PRECISION (for certain grid metr
 set(REPRO           OFF CACHE BOOL "Enable REPRO mode")
 set(WW3             OFF CACHE BOOL "Enable WW3")
 set(S2S             OFF CACHE BOOL "Enable S2S")
+set(DATM            OFF CACHE BOOL "Enable Data Atmosphere")
 
 ###############################################################################
 ### Set CMAKE_BUILD_TYPE for DEBUG mode
@@ -65,6 +66,7 @@ message("QUAD_PRECISION ... ${QUAD_PRECISION}")
 message("REPRO ............ ${REPRO}")
 message("WW3 .............. ${WW3}")
 message("S2S .............. ${S2S}")
+message("DATM ............. ${DATM}")
 message("")
 
 get_filename_component (C_COMPILER_NAME ${CMAKE_C_COMPILER} NAME)
@@ -118,6 +120,10 @@ endif()
 ###############################################################################
 ### Checks
 ###############################################################################
+if(DATM AND NOT S2S)
+   message(FATAL_ERROR "DATM=ON and S2S=OFF are incompatible, ABORT!")
+endif()
+
 if(S2S AND 32BIT)
    message(FATAL_ERROR "S2S=ON and 32BIT=ON are incompatible, ABORT!")
 endif()
@@ -161,12 +167,18 @@ target_include_directories(fms INTERFACE $<BUILD_INTERFACE:${CMAKE_CURRENT_BINAR
 ###############################################################################
 ### stochastic_physics
 ###############################################################################
-add_subdirectory(stochastic_physics)
+if(NOT DATM)
+  add_subdirectory(stochastic_physics)
+endif()
 
 ###############################################################################
-### FV3
+### FV3 or Data Atmosphere
 ###############################################################################
-add_subdirectory(FV3)
+if(DATM)
+  add_subdirectory(DATM)
+else()
+  add_subdirectory(FV3)
+endif()
 
 ###############################################################################
 ### WW3
@@ -237,9 +249,16 @@ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/NEMS/src/ESMFConvenienceMacros.h
 add_library(ufs ${_nems_srcs})
 
 list(APPEND _ufs_defs_private ESMF_VERSION_MAJOR=${ESMF_VERSION_MAJOR}
-                              FRONT_FMS
-                              FRONT_FV3=fv3gfs_cap_mod)
-add_dependencies(ufs fms fv3atm)
+                              FRONT_FMS)
+add_dependencies(ufs fms)
+
+if(DATM)
+  list(APPEND _ufs_defs_private FRONT_DATM=datm)
+  add_dependencies(ufs datatm)
+else()
+  list(APPEND _ufs_defs_private FRONT_FV3=fv3gfs_cap_mod)
+  add_dependencies(ufs fv3atm)
+endif()
 
 set_target_properties(ufs PROPERTIES Fortran_MODULE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/mod)
 target_include_directories(ufs PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/NEMS/src)
@@ -254,8 +273,13 @@ endif()
 target_include_directories(ufs INTERFACE $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/mod>
                                          $<INSTALL_INTERFACE:mod>)
 
-target_link_libraries(ufs PUBLIC esmf
-                                 fv3atm)
+target_link_libraries(ufs PUBLIC esmf)
+
+if(DATM)
+  target_link_libraries(ufs PUBLIC datatm)
+else()
+  target_link_libraries(ufs PUBLIC fv3atm)
+endif()
 
 if(S2S)
   list(APPEND _ufs_defs_private FRONT_MOM6=mom_cap_mod
@@ -289,6 +313,9 @@ endif()
 
 target_compile_definitions(ufs_model PRIVATE "${_ufs_model_defs_private}")
 
+if(DATM)
+  target_link_libraries(ufs_model PRIVATE ufs w3nco::w3nco_d)
+endif()
 target_link_libraries(ufs_model PRIVATE ufs
                                         esmf
                                         NetCDF::NetCDF_Fortran

README.md

@@ -1,12 +1,12 @@
 [![Read The Docs Status](https://readthedocs.org/projects/ufs-weather-model/badge/?badge=latest)](http://ufs-weather-model.readthedocs.io/)
 
-# ufs-weather-model
+# ufs-model
 
-This is the UFS weather model code.
+This is the UFS model source code.
 
 # Where to find information
 
-Start at the [ufs-weather-model wiki](https://github.com/ufs-community/ufs-weather-model/wiki) which has quick start instructions.
+Start at the [wiki](https://github.com/ufs-community/ufs-weather-model/wiki) which has quick start instructions.
 
 [User's reference guide](http://ufs-weather-model.readthedocs.io/) is hosted on read the docs.
 
@@ -19,15 +19,23 @@ The top level directory structure groups source code and input files as follow:
 | ```LICENSE.md```          | A copy of the GNU Lesser General Public License, Version 3. |
 | ```README.md```           | This file with basic pointers to more information. |
 | ```FMS/```                | Contains Flexible Modeling System source code. |
-| ```NEMS/```               | Contains NOAA Environmental Modeling System source code and nems compset runi scripts. |
+| ```NEMS/```               | Contains NOAA Environmental Modeling System source code and nems compset run scripts. |
 | ```CMEPS-interface/```    | Contains CMEPS mediator |
 | ```FV3/```                | Contains FV3 atmosphere model component including FV3 dynamical core, dynamics to physics driver, physics and IO. |
+| ```DATM/```               | Contains Data Atmosphere model component |
 | ```WW3/```                | Contains community wave modeling framework WW3. |
 | ```MOM6-interface/```     | Contains MOM6 ocean model component |
 | ```CICE-interface/```     | Contains CICE sea-ice model component including CICE6 and Icepack |
-| ```stochastic physics/``` | Contains the stochastic physics source code. |
+| ```stochastic_physics/``` | Contains the stochastic physics source code. |
 | ```cmake/```              | Contains compile option files on various platforms. |
-| ```modulefiles/```        | Contains module files on various platforms.|
+| ```modulefiles/```        | Contains module files on various platforms. |
+| ```tests/```              | Regression and unit testing framework scripts. |
+| ```build.sh```            | Script to build the model executable. (also used by `tests/`) |
+
+E.g. use of `build.sh` to build the coupled model with `FV3_GFS_v15p2` as the CCPP suite.
+```
+$> CMAKE_FLAGS="-DS2S=ON" CCPP_SUITES="FV3_GFS_v15p2" ./build.sh
+```
 
 # Disclaimer
 

tests/compile.sh

@@ -137,6 +137,10 @@ if [[ "${MAKE_OPT}" == *"S2S=Y"* ]]; then
     CMAKE_FLAGS="${CMAKE_FLAGS} -DS2S=Y"
 fi
 
+if [[ "${MAKE_OPT}" == *"DATM=Y"* ]]; then
+    CMAKE_FLAGS="${CMAKE_FLAGS} -DDATM=Y"
+fi
+
 CMAKE_FLAGS=$(trim "${CMAKE_FLAGS}")
 
 if [ $clean_before = YES ] ; then

tests/rt.conf

@@ -190,3 +190,9 @@ RUN     | cpld_fv3_ccpp_384_mom6_cice_cmeps_ww3_1d_bmark_rt
 
 COMPILE | CCPP=Y DEBUG=Y SUITES=FV3_GFS_2017_coupled,FV3_GFS_2017_satmedmf_coupled,FV3_GFS_v15p2_coupled S2S=Y  | standard | hera.intel orion.intel wcoss_dell_p3 | fv3 |
 RUN     | cpld_fv3_ccpp_mom6_cice_cmeps_6h_debug                                                                | standard | hera.intel orion.intel wcoss_dell_p3 | fv3 |
+
+#######################################################################################################################################################################################
+# Data Atmosphere tests
+#######################################################################################################################################################################################
+
+COMPILE | DATM=Y S2S=Y                                                                                          | standard | hera.intel orion.intel wcoss_dell_p3 | fv3 |