Bugfix/wdboggs/i3248 test max action

.circleci/config.yml

@@ -33,7 +33,9 @@ workflows:
             - docker-hub-creds
           matrix:
             parameters:
-              compiler: [gfortran, ifort, ifx]
+              # MAPL3 Unit tests still have issues with ifx. Until we fix them, we will only run with gfortran and ifort
+              #compiler: [gfortran, ifort, ifx]
+              compiler: [gfortran, ifort]
               cmake_generator: ['Unix Makefiles','Ninja']
           baselibs_version: *baselibs_version
           repo: MAPL
@@ -42,20 +44,22 @@ workflows:
           ctest_options: "-L 'ESSENTIAL' --output-on-failure"
           persist_workspace: true # Needed for MAPL tutorials
 
-      # Builds MAPL like UFS does (no FLAP and pFlogger, static)
+      # Builds MAPL without PFLOGGER and FARGPARSE
       - ci/build:
-          name: build-UFS-MAPL-on-<< matrix.compiler >>
+          name: build-MAPL-without-pFlogger-and-fArgParse-on-<< matrix.compiler >>
           context:
             - docker-hub-creds
           matrix:
             parameters:
-              compiler: [gfortran, ifort, ifx]
+              # MAPL3 Unit tests still have issues with ifx. Until we fix them, we will only run with gfortran and ifort
+              #compiler: [gfortran, ifort, ifx]
+              compiler: [gfortran, ifort]
           baselibs_version: *baselibs_version
           repo: MAPL
           mepodevelop: false
           remove_flap: true
           remove_pflogger: true
-          extra_cmake_options: "-DBUILD_WITH_FLAP=OFF -DBUILD_WITH_PFLOGGER=OFF -DBUILD_WITH_FARGPARSE=OFF -DUSE_EXTDATA2G=OFF -DBUILD_SHARED_MAPL=OFF"
+          extra_cmake_options: "-DBUILD_WITH_PFLOGGER=OFF -DBUILD_WITH_FARGPARSE=OFF"
           run_unit_tests: true
           # ExtData1G tests were removed from ESSENTIAL, so we run them separately here as UFS might still use 1G?
           ctest_options: "-L 'ESSENTIAL|EXTDATA1G_SMALL_TESTS' --output-on-failure"
@@ -67,7 +71,9 @@ workflows:
             - docker-hub-creds
           matrix:
             parameters:
-              compiler: [ifort, ifx]
+              # MAPL3 Unit tests still have issues with ifx. Until we fix them, we will only run with gfortran and ifort
+              #compiler: [ifort, ifx]
+              compiler: [ifort]
           baselibs_version: *baselibs_version
           repo: MAPL
           mepodevelop: false
@@ -82,7 +88,8 @@ workflows:
             - docker-hub-creds
           matrix:
             parameters:
-              compiler: [gfortran, ifort, ifx]
+              # MAPL3 Unit tests still have issues with ifx. Until we fix them, we will only run with gfortran and ifort
+              compiler: [gfortran, ifort]
               tutorial_name:
                 - hello_world
                 - parent_no_children
@@ -108,7 +115,9 @@ workflows:
           baselibs_version: *baselibs_version
           repo: GEOSgcm
           checkout_fixture: true
+          fixture_branch: release/MAPL-v3
           mepodevelop: true
+          checkout_mapl3_release_branch: true
           checkout_mapl_branch: true
           persist_workspace: true # Needs to be true to run fv3/gcm experiment, costs extra, retained for one day
 
@@ -156,7 +165,8 @@ workflows:
           repo: GEOSldas
           mepodevelop: false
           checkout_fixture: true
-          fixture_branch: develop
+          fixture_branch: release/MAPL-v3
+          checkout_mapl3_release_branch: true
           checkout_mapl_branch: true
 
   build-GEOSadas:
@@ -173,7 +183,8 @@ workflows:
           baselibs_version: *baselibs_version
           repo: GEOSadas
           checkout_fixture: true
-          fixture_branch: feature/mathomp4/mapldevelop
+          fixture_branch: release/MAPL-v3
+          checkout_mapl3_release_branch: true
           checkout_mapl_branch: true
           mepodevelop: false
           rebuild_procs: 4

.github/workflows/changelog-enforcer.yml

@@ -7,6 +7,9 @@ jobs:
   # Enforces the update of a changelog file on every pull request
   changelog:
     runs-on: ubuntu-latest
+    # We only want to run this job if the base_ref of the PR is *NOT*
+    # release/MAPL-v3
+    if: "!startsWith(github.base_ref, 'release/MAPL-v3')"
     steps:
     - uses: dangoslen/changelog-enforcer@v3
       with:

.github/workflows/mapl3docs.yml

@@ -0,0 +1,49 @@
+name: mapl3docs
+
+on:
+  push:
+    branches:
+      - release/MAPL-v3
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-deploy-mapl3-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build and Deploy Dev Docs
+        uses: ./.github/actions/deploy-ford-docs
+        with:
+          # Due to a bug in ford, for now we do *not* want to use
+          # the full path to the ford input file. Rather, the
+          # action will cd into docs/Ford and then run ford
+          # relative path to the ford input file.
+          ford-input: mapl3docs-with-remote-esmf.md
+          doc-folder: docs/Ford/mapl3-doc
+          token: ${{ secrets.GITHUB_TOKEN }}
+          target-folder: mapl3-doc
+
+  ##############################################################################
+  # build-and-deploy-mapl3-dev-docs:                                           #
+  #   runs-on: ubuntu-latest                                                   #
+  #   steps:                                                                   #
+  #     - name: Checkout                                                       #
+  #       uses: actions/checkout@v4                                            #
+  #                                                                            #
+  #     - name: Build and Deploy Dev Docs                                      #
+  #       uses: ./.github/actions/deploy-ford-docs                             #
+  #       with:                                                                #
+  #         # Due to a bug in ford, for now we do *not* want to use            #
+  #         # the full path to the ford input file. Rather, the                #
+  #         # action will cd into docs/Ford and then run ford                  #
+  #         # relative path to the ford input file.                            #
+  #         ford-input: mapl3docs-with-remote-esmf.public_private_protected.md #
+  #         doc-folder: docs/Ford/mapl3-dev-doc                                #
+  #         token: ${{ secrets.GITHUB_TOKEN }}                                 #
+  #         target-folder: mapl3-dev-doc                                       #
+  ##############################################################################

Apps/time_ave_util.F90

@@ -126,6 +126,7 @@ program  time_ave
    logical :: file_has_lev
    type(DistributedProfiler), target :: t_prof
    type(ProfileReporter) :: reporter
+   type(ESMF_Info) :: infoh
 
 ! **********************************************************************
 ! ****                       Initialization                         ****
@@ -383,7 +384,8 @@ program  time_ave
    else
       output_grid = input_grid
    end if
-   call ESMF_AttributeGet(output_grid,'GridType',grid_type,_RC)
+   call ESMF_InfoGetFromHost(output_grid,infoh,_RC)
+   call ESMF_InfoGet(infoh,'GridType',grid_type,_RC)
    allow_zonal_means = trim(grid_type) == 'LatLon'
    if (trim(grid_type) == "Cubed-Sphere") then
       _ASSERT(mod(npes,6)==0,"If input files are Cubed-Sphere, must be run on multiple of 6 proccessors")
@@ -1232,21 +1234,23 @@ subroutine add_new_field_to_bundle(bundle,grid,lm,field_name,long_name,units,rc)
 
       integer :: status
       type(ESMF_Field) :: field
+      type(ESMF_Info) :: infoh
 
       if (lm == 0) then
          field = ESMF_FieldCreate(grid,name=trim(field_name),typekind=ESMF_TYPEKIND_R4,_RC)
       else if (lm > 0) then
          field = ESMF_FieldCreate(grid,name=trim(field_name),typekind=ESMF_TYPEKIND_R4, &
                ungriddedLBound=[1],ungriddedUBound=[lm],_RC)
       end if
-      call ESMF_AttributeSet(field,name='LONG_NAME',value=trim(long_name),_RC)
-      call ESMF_AttributeSet(field,name='UNITS',value=trim(units),_RC)
+      call ESMF_InfoGetFromHost(field,infoh,_RC)
+      call ESMF_InfoSet(infoh,key='LONG_NAME',value=trim(long_name),_RC)
+      call ESMF_InfoSet(infoh,key='UNITS',value=trim(units),_RC)
       if (lm == 0) then
-         call ESMF_AttributeSet(field,name='DIMS',value=MAPL_DimsHorzOnly,_RC)
-         call ESMF_AttributeSet(field,name='VLOCATION',value=MAPL_VLocationNone,_RC)
+         call ESMF_InfoSet(infoh,key='DIMS',value=MAPL_DimsHorzOnly,_RC)
+         call ESMF_InfoSet(infoh,key='VLOCATION',value=MAPL_VLocationNone,_RC)
       else if (lm > 0) then
-         call ESMF_AttributeSet(field,name='DIMS',value=MAPL_DimsHorzVert,_RC)
-         call ESMF_AttributeSet(field,name='VLOCATION',value=MAPL_VLocationCenter,_RC)
+         call ESMF_InfoSet(infoh,key='DIMS',value=MAPL_DimsHorzVert,_RC)
+         call ESMF_InfoSet(infoh,key='VLOCATION',value=MAPL_VLocationCenter,_RC)
       end if
       call MAPL_FieldBundleAdd(bundle,field,_RC)
       if (present(rc)) then
@@ -1326,6 +1330,7 @@ function get_long_names(bundle,rc) result(long_names)
       integer :: status
       character(len=ESMF_MAXSTR), allocatable :: field_list(:)
       type(ESMF_Field) :: field
+      type(ESMF_Info) :: infoh
       integer :: i,num_fields
 
       call ESMF_FieldBundleGet(bundle,fieldCount=num_fields,_RC)
@@ -1334,7 +1339,8 @@ function get_long_names(bundle,rc) result(long_names)
       call ESMF_FieldBundleGet(bundle,fieldNameList=field_list,_RC)
       do i=1,num_fields
          call ESMF_FieldBundleGet(bundle,field_list(i),field=field,_RC)
-         call ESMF_AttributeGet(field,name='LONG_NAME',value=long_names(i),_RC)
+         call ESMF_InfoGetFromHost(field,infoh,_RC)
+         call ESMF_InfoGet(infoh,key='LONG_NAME',value=long_names(i),_RC)
       enddo
       if (present(rc)) then
          RC=_SUCCESS
@@ -1349,6 +1355,7 @@ function get_units(bundle,rc) result(units)
       integer :: status
       character(len=ESMF_MAXSTR), allocatable :: field_list(:)
       type(ESMF_Field) :: field
+      type(ESMF_Info) :: infoh
       integer :: i,num_fields
 
       call ESMF_FieldBundleGet(bundle,fieldCount=num_fields,_RC)
@@ -1357,7 +1364,8 @@ function get_units(bundle,rc) result(units)
       call ESMF_FieldBundleGet(bundle,fieldNameList=field_list,_RC)
       do i=1,num_fields
          call ESMF_FieldBundleGet(bundle,field_list(i),field=field,_RC)
-         call ESMF_AttributeGet(field,name='UNITS',value=units(i),_RC)
+         call ESMF_InfoGetFromHost(field,infoh,_RC)
+         call ESMF_InfoGet(infoh,key='UNITS',value=units(i),_RC)
       enddo
       if (present(rc)) then
          RC=_SUCCESS

CHANGELOG.md

@@ -5,12 +5,81 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [v3.0.0 - Development]
+
+### Removed
+
+- Removes backward compatibility for MAPL_FargparseCLI functions. Only accepts function usage in which the result is of
+  MAPL_CapOptions type.
+- Remove FLAP support.
+- Remove `BUILD_SHARED_MAPL` CMake option. MAPL3 is now always built as a shared library.
+
+### Added
+
+- Moved generic3g from using yafyaml to ESMF HConfig for yaml parsing
+- Tests for wildcard field specification in History
+- New generic3g directory intended to replace existing generic directory when completed.
+  - Modules there temporarily have `mapl3g_` as the prefix.
+- New command line switches for activating global time and memory
+    profiling.  The default is off.  Use `--enable_global_timeprof` and
+    `--enable_global_memprof` to activate.
+- New gauge for measuring memory allocation based upon mallinfo().
+	MAPL is now instrumented with this memory profiler and it produces
+	reasonable results.  Should nicely complement other tools that
+	measure HWM.
+- Replace ESMF_Attribute calls with ESMF_Info calls in MAPL_FieldCopyAttribute
+- Convert values in ESMF\_Field with compatible units using udunits2.
+- Add make_geom function in new module mapl3g_HistoryCollectionGridComp_private.
+- Use anchors for reading HConfig in Test_HistoryGridComp.
+- Add procedures for MAPL_GetResource from ESMF_HConfig.
+- Added GitHub Action to generate MAPL3 Ford Docs
+- Added capability for HistoryCollectionGridComp to extract field names from expressions
+- Added ability for HistoryCollectionGridComp to extract multiple field names from expressions
+- Added vertical and ungridded dimensions to output for History3G
+- Create rank-agnostic representation of `ESMF_Field` objects as rank-3 array pointers.
+- Add time accumulation for output from ESMF_Field objects.
+- Add tests for time accumulation
+- Add variable to FieldSpec for accumulation type
+- Add accumulation type variable to VariableSpec and ComponentSpecParser
+- Add run_dt to ComponentSpec and ComponentSpecParser
+- Add run_dt to FieldSpec
+
+### Changed
+
+- Profile reporting has been relocated into the `./profile` directory.
+- Improved diagnostic message for profiler imbalances at end of run.
+  Now gives the name of the timer that has not been stopped when
+  finalizing a profiler.
+- Changed all ESMF_AttributeGet and ESMF_AttributeSet to ESMF_InfoGet and ESMF_InfoSet respectively as old calls will be deprecated soon.
+- Update executables using FLAP to use fArgParse
+- Update `Findudunits.cmake` to link with libdl and look for the `udunits2.xml` file (as some MAPL tests require it)
+- Modified `ESMF_GridComp` creation in `GenericGridComp` to use `ESMF_CONTEXT_PARENT_VM` by default.
+- Changed `get_fptr_shape` in `FieldCondensedArray*.F90`
+- Change name of ExtensionAction%run to ExtensionAction%update in the abstract type and derived types.
+- Add invalid method to ExtensionAction with a no-op implementation in the abstract type
+
+### Fixed
+
+- Fixed failures to fully trap errors in
+  - History GC
+  - MemUtils
+  - `register_generic_entry_points`
+- Implemented workaround for NAG related to ArrayReference use in GriddedIO.
+- Implemented workarounds to avoid needing `-dusty` for NAG.  (Related PR in ESMA_CMake.)
+- Added constructor for DSO_SetServicesWrapper
+- Change macro in field/undo_function_overload.macro
+- Fixed bug with AccumulatorAction and subtypes
+
 ## [Unreleased]
 
 ### Added
 
+- Added loggers when writing or reading weight files
+
 ### Changed
 
+- Increased formatting width of time index in ExtData2G diagnostic print
+
 ### Fixed
 
 ### Removed
@@ -440,11 +509,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Update CI to use circleci-tools v2
 - Changed the Python MAPL `__init__.py` file to restore behavior from pre-Python3 transition where we did `from foo import *`. Also fix up other Python2 code to Python3.
 
+- Improved error message for missing labels in GridManager.
+
 ### Fixed
 
 - Fixed bug broken multi-step file output in History under certain template conditions
 - [#2433] Implemented workarounds for gfortran-13
 - Missing TARGET in GriddedIO - exposed runtime error when using NAG + debug.
+- Corrected some unit tests (and test utilities) to fix dangling pointers detected by NAG.  Most (possibly all) of these changes are already on release/MAPL-v3, but it was getting annoying to have NAG fail unit tests with develop branch.
+- Fix for CMake an Apple.  Needs to set `__DARWIN` as an fpp flag.  (Only used by NAG, but ...)
 - Allow ExtData2G to be built as SHARED or STATIC
 
 ## [2.42.4] - 2023-12-10

CMakeLists.txt

@@ -61,14 +61,6 @@ endif ()
 # This tells cmake to assume MAPL's cmake directory is the first place to look
 list (PREPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake")
 
-option (BUILD_SHARED_MAPL "Build shared MAPL libraries" ON)
-if (BUILD_SHARED_MAPL)
-  set (MAPL_LIBRARY_TYPE SHARED)
-else ()
-  set (MAPL_LIBRARY_TYPE STATIC)
-endif()
-message (STATUS "Building MAPL as ${MAPL_LIBRARY_TYPE} libraries")
-
 # Some users of MAPL build GFE libraries inline with their application
 # using an add_subdirectory() call rather than as a pre-build library.
 # This would then populate the target already leading to find_package()
@@ -126,11 +118,6 @@ if (BUILD_WITH_PFLOGGER)
   message (STATUS "Found pFlogger: ${PFLOGGER_DIR} (found version ${PFLOGGER_VERSION})")
 endif()
 
-option(BUILD_WITH_FLAP "Use FLAP for command line processing" OFF)
-if (BUILD_WITH_FLAP)
-  find_package(FLAP REQUIRED)
-endif ()
-
 ecbuild_declare_project()
 
 if (NOT Baselibs_FOUND)
@@ -222,24 +209,37 @@ add_subdirectory (udunits2f)
 add_subdirectory (pfio)
 add_subdirectory (profiler)
 add_subdirectory (generic)
-add_subdirectory (field_utils)
+add_subdirectory (generic3g)
+add_subdirectory (field)
+add_subdirectory (field_bundle)
 add_subdirectory (oomph) # temporary - will rename to generic when done
 add_subdirectory (shared)
 add_subdirectory (include)
 add_subdirectory (base)
 add_subdirectory (MAPL)
+add_subdirectory (mapl3g)
 add_subdirectory (gridcomps)
 add_subdirectory (griddedio)
+add_subdirectory (GeomIO)
+add_subdirectory (esmf_utils)
 if (BUILD_WITH_FARGPARSE)
    add_subdirectory (docs)
    add_subdirectory (benchmarks)
 endif()
 
+add_subdirectory (geom_mgr)
+add_subdirectory (regridder_mgr)
+add_subdirectory (hconfig_utils)
+
 if (PFUNIT_FOUND)
   include (add_pfunit_ctest)
   add_subdirectory (pfunit EXCLUDE_FROM_ALL)
 endif ()
 
+# Support for automated code generation
+include(mapl_acg)
+include(mapl_create_stub_component)
+
 add_subdirectory (Tests)
 
 # @env will exist here if MAPL is built as itself but not as part of, say, GEOSgcm