Merge branch 'develop' into features/pcolarco/CARMA_GOCART2G_coupling

GEOS-ESM · Aug 15, 2024 · 1485ddb · 1485ddb
2 parents 0df6493 + e407b24
commit 1485ddb
Show file tree

Hide file tree

Showing 92 changed files with 1,997 additions and 3,143 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,11 +1,11 @@
 version: 2.1
 
-# Anchors to prevent forgetting to update a version
-baselibs_version: &baselibs_version v7.5.0
-bcs_version: &bcs_version v10.23.0
+# Anchors in case we need to override the defaults from the orb
+#baselibs_version: &baselibs_version v7.17.0
+#bcs_version: &bcs_version v11.3.0
 
 orbs:
-  ci: geos-esm/circleci-tools@1
+  ci: geos-esm/circleci-tools@2
 
 workflows:
   build-and-test:
@@ -18,7 +18,7 @@ workflows:
           matrix:
             parameters:
               compiler: [gfortran, ifort]
-          baselibs_version: *baselibs_version
+          #baselibs_version: *baselibs_version
           repo: GOCART
           buildtarget: GOCART2G_GridComp
           mepodevelop: true
@@ -32,7 +32,7 @@ workflows:
           matrix:
             parameters:
               compiler: [gfortran, ifort]
-          baselibs_version: *baselibs_version
+          #baselibs_version: *baselibs_version
           repo: GOCART
           buildtarget: GOCART2G_GridComp
           mepodevelop: true
@@ -47,7 +47,7 @@ workflows:
           matrix:
             parameters:
               compiler: [gfortran, ifort]
-          baselibs_version: *baselibs_version
+          #baselibs_version: *baselibs_version
           repo: GEOSgcm
           checkout_fixture: true
           mepodevelop: true

diff --git a/.github/workflows/enforce-labels.yml b/.github/workflows/enforce-labels.yml
@@ -0,0 +1,29 @@
+name: Enforce PR Labels
+
+on:
+  pull_request:
+    types: [opened, labeled, unlabeled, edited, synchronize]
+
+jobs:
+  require-label:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: mheap/github-action-required-labels@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          mode: minimum
+          count: 1
+          labels: "0 diff,0 diff trivial,Non 0-diff,0 diff structural,0-diff trivial,Not 0-diff,0-diff,automatic,0-diff uncoupled"
+          add_comment: true
+  blocking-label:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: mheap/github-action-required-labels@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          mode: exactly
+          count: 0
+          labels: "Contingent - DNA,Needs Lead Approval,Contingent -- Do Not Approve"
+          add_comment: true
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,30 +7,138 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-### Added
+### Removed
 
-### Fixed
+- Removed all ExtData.rc files
 
 ### Changed
 
-## [Unreleased - Peter.R.Colarco@nasa.gov] - 2023-12-22
+- Modified the file paths in carbon, sulfate, and nitrate ExtData.yaml files to used the revised version of the CEDS anthropogenic emissions. Note the previous version has an incorrect seasonal cycle.
+
+### Fixed
+
+- Use 'CA' component name to identify carbonaceous contributions to PM in UFS diagnostic calculations. These contributions were missing due to changes in field names.
+- Add replay import patch for ozone.
+- corrected reading variable 'rhod' from files ( it was mispelled as 'rhop')
+- Silenced unwarranted error messages from wavelength/channel retrieval functions occurring when 470nm and/or 870nm channels are not included in GOCART resource file.
+- Add explicit `find_package()` calls for missing dependencies for MAPL for builds with spack-stack. Will eventually be fixed in MAPL in later versions
+- Corrected the units of the gravimetric soil moisture to percent instead of fractional in the FENGSHA dust scheme.
+- Fix issue of GOCART/GEOSgcm circular CMake dependencies when used as external project
 
 ### Added
 
+- Required attributes for the 2D GOCART export fields in AERO_DP bundle have been set in subroutine append_to_bundle in Chem_AeroGeneric.F90. These export fields are imported by OBIO via Surface GC, and the missing of the attributes was causing the writing of surface import checkpoint to fail. The issue has been explained in detail on https://github.com/GEOS-ESM/GOCART/issues/258  
+
+- Additional tuning parameters for the soil moisture and drylimit calculations for application specific tuning.
+
 - Added export line to GOCART2G_GridCompMod to couple allow use of GOCART
   SU sulfate production tendency elsewhere in Chemistry, specifically for 
   CARMA
 
 ## [2.1.2] - 2022-10-07
 
-### Added
+- Changed SU2G_instance_SU.rc to now have separate filename inputs for explosive and degassing volcanoes
+- Moved present volcanic emission inventories to one or the other line for these new entries; set other
+  line /dev/null; this is stop gap until next time we update volcanic emission inventories, at which 
+  point will provide (for AMIP and AMIP.20C) separate explosive and degassing emissions
+- Made accommodating changes for above in SU2G_GridCompMod.F90 and in the Process Library
+- Verified zero diff in current configuration (this is true of tracers and restarts, but not diagnostics:
+  until an actual split is made in the input emissions then the volcanic emissions are being assigned to
+  one or the other emission diagnostics (explosive or degassing).
+
+- Changed Chem_SettlingSimple in the process library to call Mie Query for radius and rhop inputs to the settling velocity calculation. The calls to Chem_SettlingSimple were then changed accordingly in each of the species' grid comps. Since the RH flag is no longer needed, it was removed from GA_EnvironmentMod.F90 and each of the instance RC files.
+
+
+- State Spec RC files for GOCART2G, CA, DU, NI, SU, and SS were updated such that the long names for AOD are more intuitive
+
+- Modified ExtData.yaml files to persist as climatological anthropogenic emissions after the end of the CEDS dataset in 2019. Analogous rc files removed as this capability is only available with ExtData2G
+
+- Update `components.yaml` to match that of GEOSgcm v11.6.1
+  - ESMA_env v4.29.0 (Baselibs 7.24.0, Updates for SLES15 at NCCS, various fixes)
+  - ESMA_cmake v3.48.0 (Fixes for NAS, debug flags, Updates for SLES15 at NCCS, MPI detection, ESMF and MPI CMake fixes for Spack)
+  - GMAO_Shared v1.9.8 (Bug fix for MITgcm, CI fixes, SLES15 Updates)
+  - MAPL 2.47.1 (Various fixes and features, support for Spack)
+- Update CI to use Baselibs by default from CircleCI Orb
+- Correct soil moisture parameterization in FENGSHA
+- Add `soil_moisture_factor` to the DU2G_instance_DU.rc (same name used in the K14 scheme) and DU2G_GridCompMod.F90 files for FENGSHA
+- Add `soil_drylimit_factor` to the DU2G_instance_DU.rc and DU2G_GridCompMod.F90 files for FENGSHA
+
+- Moved process library macros to header file.
+
+## [v2.2.1] - 2023-05-30
+
+### Fixed
+
+- In dust and sea-salt, changed dimensions back to `globalCellCountPerDim` since these are needed to determine emission tuning parameters, not to allocate arrays.
 
-- Extinction exports with RH=20% and RH=80%
+
+## [v2.2.0] - 2023-05-18
 
 ### Fixed
 
+- Made needed code changes in `SS2G_GridCompMod.F90` and `CA2G_GridCompMod.F90` to permit data instances of of GOCART aerosols to run
+- Added missing brown carbon (BR) climatology hooks to yaml and rc files for data driven instances
+- Changed pointers to climatological deposition inputs in yaml and rc files to `/dev/null` since the files pointed to didn't provide them anyway, and in any case they are being used presently in the model
+- Changed pointers to climatological nitrate inputs in yaml and rc files to `/dev/null` since pointing to FP files was inconsistent with MERRA-2 files used for other species
+- Ensured zero-diff in performance of yaml vs. rc files for ExtData2G vs. ExtData1g for data driven aerosols
+- To do: remove hooks to old (legacy) GOCART.data instances in CHEM and setup scripts
+- Fixed rc file in legacy O3 component.
+- Fixed issue #223 where Global dimension was being used for allocating a local array
+- This fixes a long standing issue that one can not start and stop the model in anything less than 3 hour increments to test start/stop regression because of GOCART.
+- Fix issue with scattering coefficient calculation with oc
+- Fix a long standing issue that one can not start and stop the model in anything less than 3 hour increments to test start/stop regression because of GOCART.
+
+### Changed
+
+- Comment out ASSERT to allow `GOCART_DT` to not match the `HEARTBEAT_DT`
+- Single-moment moist changes from Donifan
+- Change names of microphysics schemes to match refactored physics
+- Set `SS_SCALE` default to 0.0
+- Updates in CA2G for OpenMP
+- Updates for CI
+  - Update BCs version
+  - Update components to match GEOSgcm v11.0.0
+
+## [2.1.4] - 2023-05-12
+
+### Fixed
+
+- Fix in GOCART2G parent so that it can run with nitrates turned off. This patch of general utility was contributed by NOAA.
+
+## [2.1.3] - 2023-02-27
+
+### Added
+
+- Added `*` to CA State specs file to allow for ACG to substitute in the long name
+- Changes were made so GOCART2G and its children can be run with component level
+OpenMP threading. The key change is to create the data structure ThreadWorkspace
+to hold variables that should be private to each thread to avoid race conditions.
+Additionally spatially distributed arrays that are not in any of the ESMF states
+were added to the ESMF internal state so they could be properly handled when
+the 'mini' ESMF sates are created. Those arrays are xhno3 for NI2G, h202_init
+for SU2G, and deep_lakes_mask for SS2G. All of these arrays have MAPL_RestartSkip
+option so they are not written to restart.
+- Aerosol single scattering backscatter coefficient for each instances and total at wavelengths_profile
+- Total (molecular + aerosols) attenuated backscatter coefficient from TOA and sfc at 532nm
+
 ### Changed
 
+- Moved to use GitHub Action for label enforcement
+- For OPS configuration: removal of links, change of QFED paths from vNRT/ to v2.5r1-nrt/ (note after November 2021, files are v2.6r1)
+- For AMIP configuration: update of QFED from v2.5r1 to v2.6r1
+- Update of climatological paths from MERRAero to MERRA-2
+- Updated CircleCI image to use Baselibs 7.7.0
+- Update `components.yaml` to reflect GEOSgcm
+- CA restarts will have a change in longname for `philic` and `phobic` variables due to addition of `*` in the CA State specs file
+  for the Internal state variables
+
+## [2.1.2] - 2022-10-07
+
+## Added
+
+- Extinction/Scattering profile exports at model RH at wavelengths_profile
+- Extinction/Scattering profile exports with RH=20% and RH=80% at wavelengths_profile
+
 ## [2.1.1] - 2022-09-16
 
 ### Fixed

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -2,24 +2,42 @@ cmake_minimum_required (VERSION 3.17)
 cmake_policy (SET CMP0053 NEW)
 cmake_policy (SET CMP0054 NEW)
 
-project (
-        GOCART
-        VERSION 2.1.1
-        LANGUAGES Fortran CXX C)  # Note - CXX is required for ESMF
-
-if ("${PROJECT_SOURCE_DIR}" STREQUAL "${PROJECT_BINARY_DIR}")
-    message(SEND_ERROR "In-source builds are disabled. Please
-           issue cmake command in separate build directory.")
-endif ("${PROJECT_SOURCE_DIR}" STREQUAL "${PROJECT_BINARY_DIR}")
-
-# Set the default build type to release
-if (NOT CMAKE_BUILD_TYPE)
-    message (STATUS "Setting build type to 'Release' as none was specified.")
-    set (CMAKE_BUILD_TYPE Release CACHE STRING "Choose the type of build." FORCE)
-    # Set the possible values of build type for cmake-gui
-    set_property (CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS
-            "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
-endif ()
+# Let's look for the ESMA cmake directory in a few places
+# to see if we are building standalone
+set (ESMA_CMAKE_DIRS
+  cmake
+  @cmake
+  cmake@
+  )
+
+foreach (dir IN LISTS ESMA_CMAKE_DIRS)
+  if (EXISTS ${CMAKE_CURRENT_LIST_DIR}/${dir})
+    list (APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/${dir}")
+    set (ESMA_CMAKE_PATH "${CMAKE_CURRENT_LIST_DIR}/${dir}" CACHE PATH "Path to ESMA_cmake code")
+    set(GOCART_STANDALONE TRUE)
+  endif ()
+endforeach ()
+
+if (GOCART_STANDALONE)
+  project (
+          GOCART
+          VERSION 2.2.1
+          LANGUAGES Fortran CXX C)  # Note - CXX is required for ESMF
+
+  if ("${PROJECT_SOURCE_DIR}" STREQUAL "${PROJECT_BINARY_DIR}")
+      message(SEND_ERROR "In-source builds are disabled. Please
+            issue cmake command in separate build directory.")
+  endif ("${PROJECT_SOURCE_DIR}" STREQUAL "${PROJECT_BINARY_DIR}")
+
+  # Set the default build type to release
+  if (NOT CMAKE_BUILD_TYPE)
+      message (STATUS "Setting build type to 'Release' as none was specified.")
+      set (CMAKE_BUILD_TYPE Release CACHE STRING "Choose the type of build." FORCE)
+      # Set the possible values of build type for cmake-gui
+      set_property (CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS
+              "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
+  endif ()
+endif()
 
 # Set build options
 option (UFS_GOCART "Build GOCART component for UFS" OFF)
@@ -41,11 +59,12 @@ if (UFS_GOCART)
 endif()
 
 if (NOT COMMAND esma)
-    list (APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake@")
     include (esma)
 endif()
 
-ecbuild_declare_project()
+if(GOCART_STANDALONE)
+  ecbuild_declare_project()
+endif()
 
 if (NOT Baselibs_FOUND)
   # Find dependencies
@@ -61,6 +80,12 @@ endif ()
 
 if (UFS_GOCART)
   find_package (GFTL_SHARED REQUIRED)
+  # Dom Heinzeller 2023/08/30 - workaround until https://github.com/GEOS-ESM/MAPL/pull/2320
+  # is merged and finds its way into the ufs-weather-model dependency tree
+  find_package (YAFYAML QUIET)
+  find_package (FARGPARSE QUIET)
+  find_package (PFLOGGER QUIET)
+  #
   find_package (MAPL REQUIRED)
   include(mapl_acg)
 elseif (IS_DIRECTORY "${PROJECT_SOURCE_DIR}/ESMF/Shared/MAPL@")
@@ -81,7 +106,9 @@ include_directories(${MPI_Fortran_INCLUDE_PATH})
 add_subdirectory (ESMF)
 add_subdirectory (Process_Library)
 
-ecbuild_install_project (NAME GOCART)
+if(GOCART_STANDALONE)
+  ecbuild_install_project (NAME GOCART)
+endif()
 
 # https://www.scivision.dev/cmake-auto-gitignore-build-dir/
 # --- auto-ignore build directory