Auto PR - develop → MAPL-v3 - Updated introductory comments in GEOS_SurfaceGridComp.rc

.circleci/config.yml

@@ -1,11 +1,11 @@
 version: 2.1
 
 # Anchors in case we need to override the defaults from the orb
-#baselibs_version: &baselibs_version v7.17.0
-#bcs_version: &bcs_version v11.4.0
+#baselibs_version: &baselibs_version v7.27.0
+#bcs_version: &bcs_version v11.6.0
 
 orbs:
-  ci: geos-esm/circleci-tools@2
+  ci: geos-esm/circleci-tools@4
 
 workflows:
   build-test:
@@ -45,7 +45,7 @@ workflows:
             - docker-hub-creds
           matrix:
             parameters:
-              compiler: [gfortran, ifort]
+              compiler: [ifort]
           requires:
             - build-GEOSgcm-on-<< matrix.compiler >>
           repo: GEOSgcm

.github/workflows/spack-ci.yml

@@ -0,0 +1,123 @@
+name: Spack CI GCC Build
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    # Do not run if the only files changed cannot affect the build
+    paths-ignore:
+      - "**.md"
+      - "**.pro"
+      - "**.sh"
+      - "**.perl"
+      - ".github/CODEOWNERS"
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+jobs:
+  build_gcm:
+    name: Spack CI GCC Build
+    runs-on: ubuntu-24.04
+    steps:
+
+      - name: Checkout GCM
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+          filter: blob:none
+          repository: GEOS-ESM/GEOSgcm
+
+      - name: Set all directories as git safe
+        run: |
+          git config --global --add safe.directory '*'
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Pip install mepo
+        run: |
+          python -m pip install --upgrade pip
+          pip install mepo
+          mepo --version
+
+      - name: Mepo clone external repos
+        run: |
+          ls
+          mepo clone --partial blobless
+          mepo status
+
+      - name: Mepo develop usual suspects
+        run: |
+          ls
+          mepo develop GEOSgcm_GridComp GEOSgcm_App GMAO_Shared GEOS_Util
+          mepo status
+
+      - name: Debug PR branch
+        run: echo "PR is coming from ${{ github.event.pull_request.head.ref }}"
+
+      - name: Update other branches
+        if: ${{ github.event.pull_request.head.ref != 'main' && github.event.pull_request.head.ref != 'develop' }}
+        run: |
+          mepo checkout-if-exists ${GITHUB_HEAD_REF}
+          mepo status
+
+      - name: Set up Spack
+        uses: spack/setup-spack@v2
+        with:
+          ref: develop      # Spack version (examples: develop, releases/v0.21)
+          color: true       # Force color output (SPACK_COLOR=always)
+          path: spack       # Where to clone Spack
+          buildcache: false # Do not use the spack buildcache
+
+      - name: Find compilers
+        shell: spack-bash {0}
+        run: |
+          spack compiler find
+
+      - name: Set default compiler and target
+        shell: spack-bash {0}
+        run: |
+          spack config add 'packages:all:require:target=x86_64_v3'
+
+      - name: Create Spack environment
+        shell: spack-bash {0}
+        run: |
+          spack env create spack-env
+          spack env activate spack-env
+
+      - name: Login
+        shell: spack-bash {0}
+        run: |
+          spack -e spack-env mirror add geos-buildcache oci://ghcr.io/GEOS-ESM/geos-buildcache
+          spack -e spack-env mirror set --oci-username-variable "${{ secrets.BUILDCACHE_USERNAME }}" --oci-password-variable "${{ secrets.BUILDCACHE_TOKEN }}" geos-buildcache
+          spack -e spack-env mirror list
+          spack -e spack-env buildcache list --allarch
+
+      - name: Concretize
+        shell: spack-bash {0}
+        run: |
+          spack -e spack-env concretize
+
+      - name: Install
+        shell: spack-bash {0}
+        run: |
+          spack clean -m
+          spack -e spack-env install --add --no-check-signature --use-buildcache only \
+            esmf gftl gftl-shared fargparse pflogger pfunit yafyaml ecbuild udunits openblas
+
+      - name: Build with Cmake
+        shell: spack-bash {0}
+        run: |
+          spack env activate spack-env
+          spack load \
+            esmf gftl gftl-shared fargparse pflogger pfunit yafyaml ecbuild udunits openblas
+          spack find --loaded
+          FC=gfortran-14 CC=gcc-14 CXX=g++-14
+          cmake -B build -S . -DCMAKE_INSTALL_PREFIX=$PWD/install -DCMAKE_BUILD_TYPE=Debug -DUSE_F2PY=OFF -DCMAKE_Fortran_COMPILER=${FC} -DCMAKE_C_COMPILER=${CC} -DCMAKE_CXX_COMPILER=${CXX}
+          cmake --build build -j 4
+          cmake --install build
+

.github/workflows/workflow.yml

@@ -0,0 +1,85 @@
+name: Build Tests
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    # Do not run if the only files changed cannot affect the build
+    paths-ignore:
+      - "**.md"
+      - "**.pro"
+      - "**.sh"
+      - "**.perl"
+      - ".github/CODEOWNERS"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+jobs:
+  build_gcm:
+    name: Build GEOSgcm
+    if: "!contains(github.event.pull_request.labels.*.name, '0 diff trivial')"
+    runs-on: ubuntu-24.04
+    container:
+      image: gmao/ubuntu24-geos-env:v7.33.0-intelmpi_2021.13-ifort_2021.13
+      # Per https://github.com/actions/virtual-environments/issues/1445#issuecomment-713861495
+      # It seems like we might not need secrets on GitHub Actions which is good for forked
+      # pull requests
+      #credentials:
+        #username: ${{ secrets.DOCKERHUB_USERNAME }}
+        #password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+    env:
+      OMPI_ALLOW_RUN_AS_ROOT: 1
+      OMPI_ALLOW_RUN_AS_ROOT_CONFIRM: 1
+      OMPI_MCA_btl_vader_single_copy_mechanism: none
+
+    steps:
+      # https://github.com/orgs/community/discussions/25678#discussioncomment-5242449
+      - name: Delete huge unnecessary tools folder
+        run: rm -rf /opt/hostedtoolcache
+
+      - name: Checkout GCM
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+          filter: blob:none
+          repository: GEOS-ESM/GEOSgcm
+
+      - name: Set all directories as git safe
+        run: |
+          git config --global --add safe.directory '*'
+
+      - name: Versions etc.
+        run: |
+          ifort --version
+          mpirun --version
+          echo $BASEDIR
+
+      - name: Mepo clone external repos
+        run: |
+          mepo clone --partial blobless
+          mepo status
+
+      - name: Mepo develop usual suspects
+        run: |
+          mepo develop GEOSgcm_GridComp GEOSgcm_App GMAO_Shared GEOS_Util
+          mepo status
+
+      - name: Debug PR branch
+        run: echo "PR is coming from ${{ github.event.pull_request.head.ref }}"
+
+      - name: Update other branches
+        if: ${{ github.event.pull_request.head.ref != 'main' && github.event.pull_request.head.ref != 'develop' }}
+        run: |
+          mepo checkout-if-exists ${GITHUB_HEAD_REF}
+          mepo status
+
+      - name: CMake
+        run: |
+          cmake -B build -S . --install-prefix=${pwd}/install -DCMAKE_Fortran_COMPILER=ifort -DCMAKE_BUILD_TYPE=Debug -DMPIEXEC_PREFLAGS='--oversubscribe' -DUSE_F2PY=OFF
+
+      - name: Build
+        run: |
+          cmake --build build -j 4
+          cmake --install build

CMakeLists.txt

@@ -8,6 +8,11 @@ set (alldirs
   GEOSwgcm_GridComp
   )
 
+option(BUILD_WITH_GIGATRAJ "Build GEOSgcm with Gigatraj" OFF)
+
+if (BUILD_WITH_GIGATRAJ)
+  list(APPEND alldirs GEOSgigatraj_GridComp)
+endif()
 
 if (EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/GEOS_GcmGridComp.F90)
 
@@ -17,6 +22,8 @@ if (EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/GEOS_GcmGridComp.F90)
     SUBCOMPONENTS ${alldirs}
     DEPENDENCIES MAPL ESMF::ESMF)
 
+  target_compile_definitions (${this} PRIVATE $<$<BOOL:${BUILD_WITH_GIGATRAJ}>:HAS_GIGATRAJ>)
+
   ecbuild_install_project( NAME GEOSgcm_GridComp)
 
 else ()

GEOS_GcmGridComp.F90

@@ -20,6 +20,10 @@ module GEOS_GcmGridCompMod
    use GEOS_AgcmGridCompMod,     only:  AGCM_SetServices => SetServices
    use GEOS_mkiauGridCompMod,    only:  AIAU_SetServices => SetServices
    use DFI_GridCompMod,          only:  ADFI_SetServices => SetServices
+#ifdef HAS_GIGATRAJ
+   use GEOS_GigatrajGridCompMod, only:  GigaTraj_SetServices => SetServices
+#endif
+
    use GEOS_OgcmGridCompMod,     only:  OGCM_SetServices => SetServices
    use GEOS_WgcmGridCompMod,     only:  WGCM_SetServices => SetServices
    use MAPL_HistoryGridCompMod,  only:  Hist_SetServices => SetServices
@@ -58,6 +62,7 @@ module GEOS_GcmGridCompMod
 integer ::       ADFI
 integer ::       WGCM
 integer ::       hist
+integer ::       gigatraj
 
 integer :: bypass_ogcm
 integer ::       k
@@ -251,6 +256,10 @@ subroutine SetServices ( GC, RC )
     else
        AGCM = MAPL_AddChild(GC, NAME='AGCM', SS=Agcm_SetServices, RC=STATUS)
        VERIFY_(STATUS)
+#ifdef HAS_GIGATRAJ
+       gigatraj = MAPL_AddChild(GC, NAME='GIGATRAJ', SS=GigaTraj_SetServices, RC=STATUS)
+       VERIFY_(STATUS)
+#endif
        AIAU = MAPL_AddChild(GC, NAME='AIAU', SS=AIAU_SetServices, RC=STATUS)
        VERIFY_(STATUS)
        ADFI = MAPL_AddChild(GC, NAME='ADFI', SS=ADFI_SetServices, RC=STATUS)
@@ -955,6 +964,10 @@ subroutine Initialize ( GC, IMPORT, EXPORT, CLOCK, RC )
 ! Recursive setup of grids (should be disabled)
     call ESMF_GridCompSet(GCS(AGCM),  grid=agrid, rc=status)
     VERIFY_(STATUS)
+#ifdef HAS_GIGATRAJ
+    call ESMF_GridCompSet(GCS(gigatraj),  grid=agrid, rc=status)
+    VERIFY_(STATUS)
+#endif
     call ESMF_GridCompSet(GCS(OGCM),  grid=ogrid, rc=status)
     VERIFY_(STATUS)
     if(.not. DO_DATA_ATM4OCN) then
@@ -1308,15 +1321,17 @@ subroutine Initialize ( GC, IMPORT, EXPORT, CLOCK, RC )
          result=GCM_INTERNAL_STATE%SURF_IMP, rc=status)
     VERIFY_(STATUS)
 
-    !select TURBULENCE export
-    call MAPL_ExportStateGet(GEX, name='TURBULENCE', &
-         result=GCM_INTERNAL_STATE%TURB_EXP, rc=status)
-    VERIFY_(STATUS)
+    if(.not. DO_DATA_ATM4OCN) then
+      !select TURBULENCE export
+      call MAPL_ExportStateGet(GEX, name='TURBULENCE', &
+           result=GCM_INTERNAL_STATE%TURB_EXP, rc=status)
+      VERIFY_(STATUS)
 
-    !select SURFACE import 
-    call MAPL_ImportStateGet(GC, import=import, name='TURBULENCE', &
-         result=GCM_INTERNAL_STATE%TURB_IMP, rc=status)
-    VERIFY_(STATUS)
+      !select TURBULENCE import 
+      call MAPL_ImportStateGet(GC, import=import, name='TURBULENCE', &
+           result=GCM_INTERNAL_STATE%TURB_IMP, rc=status)
+      VERIFY_(STATUS)
+    endif
 
     !select OCEAN export
     call MAPL_ExportStateGet(GEX, name='OCEAN', &
@@ -2017,10 +2032,23 @@ subroutine Run ( GC, IMPORT, EXPORT, CLOCK, RC )
     else
       call MAPL_TimerOn(MAPL,"AGCM"        )
     endif
+
+#ifdef HAS_GIGATRAJ
+    ! use agcm export as gigatraj's import to get the initial state.
+    ! it only runs at the begining of the first time step
+    call ESMF_GridCompRun ( GCS(gigatraj), importState=GEX(AGCM), exportState=GEX(gigatraj), clock=clock, phase=1, userRC=status )
+    VERIFY_(STATUS)
+#endif
 
     call ESMF_GridCompRun ( GCS(AGCM), importState=GIM(AGCM), exportState=GEX(AGCM), clock=clock, userRC=status )
     VERIFY_(STATUS)
 
+#ifdef HAS_GIGATRAJ
+    ! use agcm export as gigatraj's import
+    call ESMF_GridCompRun ( GCS(gigatraj), importState=GEX(AGCM), exportState=GEX(gigatraj), clock=clock, phase=2, userRC=status )
+    VERIFY_(STATUS)
+#endif
+
     if(DO_DATA_ATM4OCN) then
       call MAPL_TimerOff(MAPL,"DATAATM"     )
     else

GEOSagcm_GridComp/CMakeLists.txt

@@ -20,6 +20,8 @@ elseif (EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/GEOS_AgcmGridComp.F90)
     SUBCOMPONENTS ${alldirs}
     DEPENDENCIES MAPL GEOS_Shared Chem_Shared ESMF::ESMF)
 
+  target_compile_definitions (${this} PRIVATE $<$<BOOL:${BUILD_WITH_GIGATRAJ}>:HAS_GIGATRAJ>)
+
 else ()
 
   esma_add_subdirectories (${alldirs})

GEOSagcm_GridComp/GEOS_AgcmGridComp.F90

@@ -790,6 +790,34 @@ subroutine SetServices ( GC, RC )
          RC = STATUS)
     VERIFY_(STATUS)
 
+#ifdef HAS_GIGATRAJ
+    call MAPL_AddExportSpec(GC, &
+         SHORT_NAME = 'PL', &
+         CHILD_ID = SDYN, &
+         RC = STATUS)
+    VERIFY_(STATUS)
+    call MAPL_AddExportSpec(GC, &
+         SHORT_NAME = 'OMEGA', &
+         CHILD_ID = SDYN, &
+         RC = STATUS)
+    VERIFY_(STATUS)
+    call MAPL_AddExportSpec(GC, &
+         SHORT_NAME = 'TH', &
+         CHILD_ID = SDYN, &
+         RC = STATUS)
+    VERIFY_(STATUS)
+    call MAPL_AddExportSpec(GC,  &
+         SHORT_NAME = 'DTDTDYN', &
+         CHILD_ID = SDYN, &
+         RC = STATUS)
+    VERIFY_(STATUS)
+    call MAPL_AddExportSpec(GC,  &
+         SHORT_NAME = 'ZL', &
+         CHILD_ID = SDYN, &
+         RC = STATUS)
+    VERIFY_(STATUS)
+#endif
+
     call MAPL_AddExportSpec( GC, &
          SHORT_NAME = 'PS', &
          CHILD_ID = SDYN, &