Skip to content

Commit

Permalink
Merge pull request #1286 from GEOS-ESM/feature/tclune/#1268-readme
Browse files Browse the repository at this point in the history
Fixes #1268 - update to README.md
  • Loading branch information
mathomp4 authored Jan 10, 2022
2 parents d536b3f + f256d5e commit f98fae5
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Changed

- Updated README.md
- Refactored MAPL_Generic.F90 - lots of changes.
- consistent indentation (emacs mode)
- extracted helper procedures in GenericInitialize
Expand Down
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,17 @@

MAPL is a foundation layer of the GEOS architecture, whose original purpose is to supplement the Earth System Modeling Framework (ESMF). MAPL fills in missing capabilities of ESMF, provides higher-level interfaces for common boiler-plate logic, and enforces various componentization conventions across ESMF gridded components within GEOS.

MAPL has 7 primary subdirectories for Fortran source code.
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 - high-performance client-server I/O layer
4. generic (under construction) - new home for MAPL extension of ESMF framework.
5. base (formerly MAPL_Base) - legacy core of MAPL. This layer will gradually evaporate under further refactoring.
6. 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.
7. griddedio - layer between ESMF container and pfio library
6. generic (under construction) - new home for MAPL extension of ESMF framework.
7. oomph - next gen generic will eventually disappear
8. gridcomps - Cap, History, and ExtData 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


MAPL also has a variety of other auxiliary directories:
1. include - include files used by external gridded components.
Expand All @@ -25,6 +28,9 @@ MAPL also has a variety of other auxiliary directories:
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




Expand Down

0 comments on commit f98fae5

Please sign in to comment.