Merge pull request mom-ocean#1292 from adcroft/nuopc-api-test

Nuopc api test

.github/actions/testing-setup/action.yml

@@ -1,5 +1,14 @@
 name: 'Build-.testing-prerequisites'
 description: 'Build pre-requisites for .testing including FMS and a symmetric MOM6 executable'
+inputs:
+  build_symmetric:
+    description: 'If true, will build the symmetric MOM6 executable'
+    required: false
+    default: 'true'
+  install_python:
+    description: 'If true, will install the local python env needed for .testing'
+    required: false
+    default: 'true'
 runs:
   using: 'composite'
   steps:
@@ -51,15 +60,15 @@ runs:
       run: |
         echo "::group::Compile MOM6 in symmetric memory mode"
         cd .testing
-        make build/symmetric/MOM6 -j
+        test ${{ inputs.build_symmetric }} == true && make build/symmetric/MOM6 -j
         echo "::endgroup::"
 
     - name: Install local python venv for generating input data
       shell: bash
       run: |
         echo "::group::Create local python env for input data generation"
         cd .testing
-        make work/local-env
+        test ${{ inputs.install_python }} == true && make work/local-env
         echo "::endgroup::"
 
     - name: Set flags

.github/workflows/coupled-api.yml

@@ -0,0 +1,33 @@
+name: API for coupled drivers
+
+on: [push, pull_request]
+
+jobs:
+  test-top-api:
+
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: .testing
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: recursive
+
+    - uses: ./.github/actions/testing-setup
+      with:
+        build_symmetric: 'false'
+        install_python: 'false'
+
+    - name: Compile MOM6 for the GFDL coupled driver
+      shell: bash
+      run: make check_mom6_api_coupled -j
+
+    - name: Compile MOM6 for the NUOPC driver
+      shell: bash
+      run: make check_mom6_api_nuopc -j
+
+    - name: Compile MOM6 for the MCT driver
+      shell: bash
+      run: make check_mom6_api_mct -j

.testing/Makefile

@@ -226,15 +226,19 @@ build/asymmetric/Makefile: MOM_ENV=$(PATH_FMS) $(ASYMMETRIC_FCFLAGS) $(MOM_LDFLA
 build/repro/Makefile: MOM_ENV=$(PATH_FMS) $(REPRO_FCFLAGS) $(MOM_LDFLAGS)
 build/openmp/Makefile: MOM_ENV=$(PATH_FMS) $(OPENMP_FCFLAGS) $(MOM_LDFLAGS)
 build/target/Makefile: MOM_ENV=$(PATH_FMS) $(TARGET_FCFLAGS) $(MOM_LDFLAGS)
-
+build/coupled/Makefile: MOM_ENV=$(PATH_FMS) $(SYMMETRIC_FCFLAGS) $(SYMMETRIC_LDFLAGS)
+build/nuopc/Makefile: MOM_ENV=$(PATH_FMS) $(SYMMETRIC_FCFLAGS) $(SYMMETRIC_LDFLAGS)
+build/mct/Makefile: MOM_ENV=$(PATH_FMS) $(SYMMETRIC_FCFLAGS) $(SYMMETRIC_LDFLAGS)
 
 # Configure script flags
 build/symmetric/Makefile: MOM_ACFLAGS=
 build/asymmetric/Makefile: MOM_ACFLAGS=--enable-asymmetric
 build/repro/Makefile: MOM_ACFLAGS=
 build/openmp/Makefile: MOM_ACFLAGS=--enable-openmp
 build/target/Makefile: MOM_ACFLAGS=
-
+build/coupled/Makefile: MOM_ACFLAGS=--with-driver=coupled_driver
+build/nuopc/Makefile: MOM_ACFLAGS=--with-driver=nuopc_driver
+build/mct/Makefile: MOM_ACFLAGS=--with-driver=mct_driver
 
 # Fetch regression target source code
 build/target/Makefile: | $(TARGET_CODEBASE)
@@ -328,6 +332,25 @@ $(DEPS)/Makefile: ../ac/deps/Makefile
 	mkdir -p $(@D)
 	cp $< $@
 
+#---
+# The following block does a non-library build of a coupled driver interface to MOM, along with everything below it.
+# This simply checks that we have not broken the ability to compile. This is not a means to build a complete coupled executable.
+# Todo: 
+# - avoid re-building FMS and MOM6 src by re-using existing object/mod files
+# - use autoconf rather than mkmf templates
+MK_TEMPLATE ?= ../../$(DEPS)/mkmf/templates/ncrc-gnu.mk
+# NUOPC driver
+build/nuopc/mom_ocean_model_nuopc.o: build/nuopc/Makefile
+	cd $(@D) && make $(@F)
+check_mom6_api_nuopc: build/nuopc/mom_ocean_model_nuopc.o
+# GFDL coupled driver
+build/coupled/ocean_model_MOM.o: build/coupled/Makefile
+	cd $(@D) && make $(@F)
+check_mom6_api_coupled: build/coupled/ocean_model_MOM.o
+# MCT driver
+build/mct/mom_ocean_model_mct.o: build/mct/Makefile
+	cd $(@D) && make $(@F)
+check_mom6_api_mct: build/mct/mom_ocean_model_mct.o
 
 #---
 # Python preprocessing

ac/configure.ac

@@ -48,6 +48,12 @@ AC_ARG_ENABLE([asymmetric],
 AS_IF([test "$enable_asymmetric" = yes],
   [MEM_LAYOUT=${srcdir}/config_src/dynamic])
 
+# Default to solo_driver
+DRIVER_DIR=${srcdir}/config_src/solo_driver
+AC_ARG_WITH([driver],
+  AS_HELP_STRING([--with-driver=coupled_driver|solo_driver], [Select directory for driver source code]))
+AS_IF([test "x$with_driver" != "x"],
+  [DRIVER_DIR=${srcdir}/config_src/${with_driver}])
 
 # TODO: Rather than point to a pre-configured header file, autoconf could be
 # used to configure a header based on a template.
@@ -210,10 +216,10 @@ AS_IF([test -z "$MKMF"], [
 AC_CONFIG_COMMANDS([path_names],
   [list_paths -l \
     ${srcdir}/src \
-    ${srcdir}/config_src/solo_driver \
     ${srcdir}/config_src/ext* \
+    ${DRIVER_DIR} \
     ${MEM_LAYOUT}
-], [MEM_LAYOUT=$MEM_LAYOUT])
+], [MEM_LAYOUT=$MEM_LAYOUT DRIVER_DIR=$DRIVER_DIR])
 
 
 AC_CONFIG_COMMANDS([Makefile.mkmf],