Skip to content

Proposed MAPL Tutorial Outline

Ben Auer edited this page Mar 12, 2021 · 6 revisions
  • What is ESMF? What is MAPL
  • Relationship with ESMF
  • Why MAPL
  • MAPL place within GEOS
  • High level introduction of MAPL major functionalities and variables (with annotated APIs as sensible)
    • Cap
    • GridComp
    • Generic (SetServices, Initialize, Run, Finalize)
    • Field
    • Field Bundle
    • Grid
    • Config
    • VarSpec (Import, Export, Internal)
    • MetaComp
    • I/O
    • etc.
  • Dependencies to build and test MAPL
  • Build and run instructions
  • Frequently touched aspects by (most) users with examples
    • Resource (Configuration) Files (introduce the YAML approach?)
    • Adding a field or field bundle (including how to use VarSpec)
    • ExtData
    • History
    • etc
  • More examples geared towards users who are also developers
    • MAPL App from scratch
    • I would propose 3 complete MAPL Applications that create simple grid comps in order of complexity with voluminous comments and that demonstrate all the topics listed earlier. A driver that creates a single gridcomp (no MAPL cap), a driver that creates two and demonstrates connectivity (no MAPL cap), a mini geos that uses MAPL cap, has a simple gridcomp structure, maybe a root with 2 children, could provide files for example that would output something in history with this.
    • Could also have simple Applications (no grid comp) to demonstrate basic ESMF and some MAPL utilities, ideas - how to create a grid, fields, the MAPL regridding layers.
    • How to add a new GridComp (model, history, coupler, etc)
    • Others?
Clone this wiki locally