Auto GitFlow - main → develop

.github/workflows/docs.yml

@@ -20,8 +20,8 @@ jobs:
       - name: Build and Deploy Docs
         uses: ./.github/actions/deploy-ford-docs
         with:
-          ford-input: Ford/docs-with-remote-esmf.md
-          doc-folder: Ford/doc
+          ford-input: docs/Ford/docs-with-remote-esmf.md
+          doc-folder: docs/Ford/doc
           token: ${{ secrets.GITHUB_TOKEN }}
 
   build-and-deploy-dev-docs:
@@ -33,7 +33,7 @@ jobs:
       - name: Build and Deploy Dev Docs
         uses: ./.github/actions/deploy-ford-docs
         with:
-          ford-input: Ford/docs-with-remote-esmf.public_private_protected.md
-          doc-folder: Ford/dev-doc
+          ford-input: docs/Ford/docs-with-remote-esmf.public_private_protected.md
+          doc-folder: docs/Ford/dev-doc
           token: ${{ secrets.GITHUB_TOKEN }}
           target-folder: dev-doc

README.md

@@ -1,10 +1,5 @@
 # MAPL Repository
 
-[![Scc Count Badge](https://sloc.xyz/github/GEOS-ESM/MAPL/?category=code)](https://github.com/GEOS-ESM/MAPL/)
-[![Scc Count Badge](https://sloc.xyz/github/GEOS-ESM/MAPL/?category=comments)](https://github.com/GEOS-ESM/MAPL/)
-[![Scc Count Badge](https://sloc.xyz/github/GEOS-ESM/MAPL/?category=blanks)](https://github.com/GEOS-ESM/MAPL/)
-[![Scc Count Badge](https://sloc.xyz/github/GEOS-ESM/MAPL/?category=lines)](https://github.com/GEOS-ESM/MAPL/)
-
 [![GEOS-ESM](https://circleci.com/gh/GEOS-ESM/MAPL.svg?style=svg)](https://app.circleci.com/pipelines/github/GEOS-ESM/MAPL)
 
 [![DOI](https://zenodo.org/badge/195083467.svg)](https://zenodo.org/badge/latestdoi/195083467)
@@ -16,12 +11,13 @@ MAPL has 10 primary subdirectories for Fortran source code:
 1. **shared** - low level utilities that are used throughout the remainder of MAPL.
 2. **profiler** - time and memory profiling utility
 3. [**pfio**](https://github.com/GEOS-ESM/MAPL/tree/main/pfio) - high-performance client-server I/O layer
-5. **base** (formerly MAPL_Base) - legacy core of MAPL.   This layer will gradually evaporate under further refactoring.
-6. **generic** (under construction) - new home for MAPL extension of ESMF framework.
-7. **oomph** - next gen generic will eventually disappear
-8. **gridcomps** - Cap, [History](https://github.com/GEOS-ESM/MAPL/tree/main/gridcomps/History), and [ExtData](https://github.com/GEOS-ESM/MAPL/tree/main/gridcomps/ExtData2G) gridcomps used by all GEOS configurations.
-9. **MAPL_cfio** - this is a deprecated lower-level I/O layer that is generally replaced by GMAO_pFIO.    Not all of the strings have been cut yet.  Sometime soon, this directory will be eliminated.
-10. **griddedio** - layer between ESMF container and pfio library
+4. **base** (formerly MAPL_Base) - legacy core of MAPL.   This layer will gradually evaporate under further refactoring.
+5. **generic** (under construction) - new home for MAPL extension of ESMF framework.
+6. **oomph** - next gen generic will eventually disappear
+7. **gridcomps** - Cap, [History](https://github.com/GEOS-ESM/MAPL/tree/main/gridcomps/History), and [ExtData](https://github.com/GEOS-ESM/MAPL/tree/main/gridcomps/ExtData2G) gridcomps used by all GEOS configurations.
+8. **MAPL_cfio** - this is a deprecated lower-level I/O layer that is generally replaced by GMAO_pFIO.    Not all of the strings have been cut yet.  Sometime soon, this directory will be eliminated.
+9. **griddedio** - layer between ESMF container and pfio library
+10. **field_utils** - utilities for manipulating data on ESMF fields in a rank- and typekind-agnostic way
 
 
 MAPL also has a variety of other auxiliary directories:
@@ -30,10 +26,11 @@ MAPL also has a variety of other auxiliary directories:
 2. **Apps** - various Python and Perl scripts used by gridded components.
 3. **Python** - beginnings of a run-time scripting framework for GEOS configurations
 4. **cmake** - CMake build macros
-5. **MAPL_pFUnit** - implements extensions of pFUnit unit testing framework that enable unit tests of grid comp run methods.   This layer should eventually be migrated into pFUnit itself.
-6. **Tests** - miscellaneous standalone drivers.
-7. **pflogger_stub** - workaround for apps that wish to avoid a dependency on pFlogger
-8. **pfunit** - pFUnit (unit testing framework) extensions for ESMF components
+5. **Tests** - miscellaneous standalone drivers.
+6. **pflogger_stub** - workaround for apps that wish to avoid a dependency on pFlogger
+7. **pfunit** - pFUnit (unit testing framework) extensions for ESMF components
+8. **benchmarks** - miscellaneous benchmarking scripts
+9. **docs** - documentation
 
 ## Using MAPL
 You can find simple examples on how to use MAPL components in ESMF applications at:

Ford/docs-with-remote-esmf.md → docs/Ford/docs-with-remote-esmf.md

@@ -1,29 +1,29 @@
 ---
-src_dir: ../
+src_dir: ../../
 search: true
-graph: false
+graph: true
 coloured_edges: true
 graph_maxdepth: 4
 graph_maxnodes: 32
-include: ../include/
-         ../gFTL/install/GFTL-1.10/include/v1
-         ../gFTL/install/GFTL-1.10/include/v2
+include: ../../include/
+         ../../gFTL/install/GFTL-1.10/include/v1
+         ../../gFTL/install/GFTL-1.10/include/v2
 exclude: EsmfRegridder.F90
          FieldBLAS_IntrinsicFunctions.F90
          GeomManager.F90
          MaplGeom.F90
          Regridder.F90
          StateSupplement.F90
-exclude_dir: ../Ford
-             ../Doxygen
-             ../ESMA_cmake
-             ../ESMA_env
-             ../build
-             ../gFTL
-             ../esmf
-             ../pFUnit
-             ../fArgParse
-             ../pFlogger
+exclude_dir: ../../docs
+             ../../Doxygen
+             ../../ESMA_cmake
+             ../../ESMA_env
+             ../../build
+             ../../gFTL
+             ../../esmf
+             ../../pFUnit
+             ../../fArgParse
+             ../../pFlogger
 macro: USE_MPI=1
        BUILD_WITH_PFLOGGER=1
        BUILD_WITH_EXTDATA2G=1
@@ -61,4 +61,4 @@ fpp_extensions: F90
 externalize: true
 ---
 
-{!../README.md!}
+{!../../README.md!}

Ford/docs-with-remote-esmf.public_private_protected.md → docs/Ford/docs-with-remote-esmf.public_private_protected.md

@@ -1,30 +1,30 @@
 ---
-src_dir: ../
+src_dir: ../../
 output_dir: dev-doc
 search: true
-graph: false
+graph: true
 coloured_edges: true
 graph_maxdepth: 4
 graph_maxnodes: 32
-include: ../include/
-         ../gFTL/install/GFTL-1.10/include/v1
-         ../gFTL/install/GFTL-1.10/include/v2
+include: ../../include/
+         ../../gFTL/install/GFTL-1.10/include/v1
+         ../../gFTL/install/GFTL-1.10/include/v2
 exclude: EsmfRegridder.F90
          FieldBLAS_IntrinsicFunctions.F90
          GeomManager.F90
          MaplGeom.F90
          Regridder.F90
          StateSupplement.F90
-exclude_dir: ../Ford
-             ../Doxygen
-             ../ESMA_cmake
-             ../ESMA_env
-             ../build
-             ../gFTL
-             ../esmf
-             ../pFUnit
-             ../fArgParse
-             ../pFlogger
+exclude_dir: ../../docs
+             ../../Doxygen
+             ../../ESMA_cmake
+             ../../ESMA_env
+             ../../build
+             ../../gFTL
+             ../../esmf
+             ../../pFUnit
+             ../../fArgParse
+             ../../pFlogger
 macro: USE_MPI=1
        BUILD_WITH_PFLOGGER=1
        BUILD_WITH_EXTDATA2G=1