-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
233 lines (214 loc) · 14.3 KB
/
index.html
File metadata and controls
233 lines (214 loc) · 14.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="MAPL is a foundation layer of the GEOS architecture, whose original purpose is to supplement the Earth System Modeling Framework (ESMF)">
<meta name="author" content="The MAPL Developers" >
<link rel="icon" href="./favicon.png">
<title> MAPL </title>
<!-- Bootstrap -->
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css" rel="stylesheet"
integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH" crossorigin="anonymous">
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js"
integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz" crossorigin="anonymous"></script>
<!-- Font Awesome -->
<link href="./css/fontawesome.min.css" rel="stylesheet">
<link href="./css/brands.min.css" rel="stylesheet">
<link href="./css/regular.min.css" rel="stylesheet">
<link href="./css/solid.min.css" rel="stylesheet">
<link href="./css/v4-font-face.min.css" rel="stylesheet">
<link href="./css/v4-shims.min.css" rel="stylesheet">
<!-- MathJax -->
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
TeX: { equationNumbers: { autoNumber: "AMS" } }
});
</script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@2.7.9/MathJax.js?config=TeX-AMS-MML_HTMLorMML" async
integrity="sha256-DViIOMYdwlM/axqoGDPeUyf0urLoHMN4QACBKyB58Uw=" crossorigin="anonymous"></script>
<!-- Other scripts and stylesheets -->
<link href="./css/local.css" rel="stylesheet">
<link href="./css/pygments.css" rel="stylesheet">
<script src="./js/svg-pan-zoom.min.js"></script>
</head>
<body>
<!-- Fixed navbar -->
<div class="container-fluid mb-sm-4 mb-xl-2">
<nav class="navbar navbar-expand-lg navbar-dark bg-dark fixed-top">
<div class="container">
<a class="navbar-brand" href="./index.html">MAPL </a>
<button type="button" class="navbar-toggler" data-bs-toggle="collapse" data-bs-target="#navbar"
aria-expanded="false" aria-controls="navbar" aria-label="Toggle navigation">
<span class="navbar-toggler-icon">
</button>
<div id="navbar" class="navbar-collapse collapse">
<ul class="navbar-nav">
<li class="nav-item">
<a class="nav-link" href="./lists/files.html">Source Files</a>
</li>
<li class="nav-item">
<a class="nav-link" href="./lists/modules.html">Modules</a>
</li>
<li class="nav-item">
<a class="nav-link" href="./lists/procedures.html">Procedures</a>
</li>
<li class="nav-item">
<a class="nav-link" href="./lists/absint.html">Abstract Interfaces</a>
</li>
<li class="nav-item">
<a class="nav-link" href="./lists/types.html">Derived Types</a>
</li>
<li class="nav-item">
<a class="nav-link" href="./lists/programs.html">Programs</a>
</li>
</ul>
<div class="d-flex align-items-end flex-grow-1">
<form action="./search.html" role="search" class="ms-auto">
<input type="text" class="form-control" aria-label="Search" placeholder="Search" name="q" id="tipue_search_input" autocomplete="off" required>
</form>
</div>
</div><!--/.nav-collapse -->
</div>
</nav>
</div>
<div class="container">
<!-- Main component for a primary marketing message or call to action -->
<div class="p-5 mb-4 bg-light border rounded-3" id="jumbotron">
<p>MAPL is a foundation layer of the GEOS architecture, whose original purpose is to supplement the Earth System Modeling Framework (ESMF)</p>
<p> Find us on…</p>
<p>
<a class="btn btn-lg btn-primary" href="https://github.com/GEOS-ESM/MAPL" role="button">GitHub</a>
<a class="btn btn-lg btn-primary" href="https://github.com/GEOS-ESM/MAPL" role="button">The Web</a>
</p>
</div>
<div class="row" id='text'>
<div class=col-md-8>
<h1>MAPL</h1>
<h1 id="mapl-repository">MAPL Repository</h1>
<p><a href="https://app.circleci.com/pipelines/github/GEOS-ESM/MAPL"><img alt="GEOS-ESM" src="https://circleci.com/gh/GEOS-ESM/MAPL.svg?style=svg"></a></p>
<p><a href="https://zenodo.org/badge/latestdoi/195083467"><img alt="DOI" src="https://zenodo.org/badge/195083467.svg"></a></p>
<p><a href="https://deepwiki.com/GEOS-ESM/MAPL"><img alt="Ask DeepWiki" src="https://deepwiki.com/badge.svg"></a></p>
<p>MAPL (Modeling Analysis and Prediction Layer) 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.</p>
<p>MAPL has 10 primary subdirectories for Fortran source code:</p>
<ol>
<li><strong>shared</strong> - low level utilities that are used throughout the remainder of MAPL.</li>
<li><strong>profiler</strong> - time and memory profiling utility</li>
<li><a href="https://github.com/GEOS-ESM/MAPL/tree/main/pfio"><strong>pfio</strong></a> - high-performance client-server I/O layer</li>
<li><strong>base</strong> (formerly MAPL_Base) - legacy core of MAPL. This layer will gradually evaporate under further refactoring.</li>
<li><strong>generic</strong> (under construction) - new home for MAPL extension of ESMF framework.</li>
<li><strong>oomph</strong> - next gen generic will eventually disappear</li>
<li><strong>gridcomps</strong> - Cap, <a href="https://github.com/GEOS-ESM/MAPL/tree/main/gridcomps/History">History</a>, and <a href="https://github.com/GEOS-ESM/MAPL/tree/main/gridcomps/ExtData2G">ExtData</a> gridcomps used by all GEOS configurations.</li>
<li><strong>MAPL_cfio</strong> - 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.</li>
<li><strong>griddedio</strong> - layer between ESMF container and pfio library</li>
<li><strong>field_utils</strong> - utilities for manipulating data on ESMF fields in a rank- and typekind-agnostic way</li>
</ol>
<p>MAPL also has a variety of other auxiliary directories:</p>
<ol>
<li><strong>include</strong> - include files used by external gridded components.</li>
<li><strong>Apps</strong> - various Python and Perl scripts used by gridded components.</li>
<li><strong>Python</strong> - beginnings of a run-time scripting framework for GEOS configurations</li>
<li><strong>cmake</strong> - CMake build macros</li>
<li><strong>Tests</strong> - miscellaneous standalone drivers.</li>
<li><strong>pflogger_stub</strong> - workaround for apps that wish to avoid a dependency on pFlogger</li>
<li><strong>pfunit</strong> - pFUnit (unit testing framework) extensions for ESMF components</li>
<li><strong>benchmarks</strong> - miscellaneous benchmarking scripts</li>
<li><strong>docs</strong> - documentation</li>
</ol>
<h2 id="installing-mapl">Installing MAPL</h2>
<p>Please see the <a href="INSTALL.md">INSTALL.md</a> file for instructions on how to install
MAPL. This also contains information on how to install the required dependencies
including subrepositories MAPL expects.</p>
<h2 id="using-mapl">Using MAPL</h2>
<p>You can find simple examples on how to use MAPL components in ESMF applications at:</p>
<p><a href="https://github.com/GEOS-ESM/MAPL/blob/main/docs/tutorial/README.md">MAPL Tutorial</a></p>
<p>A <a href="https://github.com/GEOS-ESM/MAPL/blob/main/docs/user_guide/README.md">MAPL User’s Guide</a> is also available to have an in depth description of MAPL components.</p>
<h2 id="contributing">Contributing</h2>
<p>Please check out our <a href="CONTRIBUTING.md">contributing guidelines</a>.</p>
<h2 id="license">License</h2>
<p>All files are currently licensed under the Apache-2.0 license, see <a href="LICENSE"><code>LICENSE</code></a>.</p>
<p>Previously, the code was licensed under the <a href="LICENSE-NOSA">NASA Open Source Agreement, Version 1.3</a>.</p>
</div>
<div class="col-md-4">
<div class="card card-body bg-light">
<h2 class="card-title">Developer Info</h2>
<h4 class="card-text">The MAPL Developers</h4>
<p class="card-text"></p>
<div class="text-center"><div class="btn-group" role="group">
<a class="btn btn-lg btn-primary" href="mailto:matthew.thompson@nasa.gov"><i class="fa fa-envelope fa-lg"></i></a>
<a class="btn btn-lg btn-primary" href="https://github.com/GEOS-ESM"><i class="fa fa-github fa-lg"></i></a>
</div></div>
</div>
</div>
</div>
<div class="row">
<hr>
<div class="col-xs-6 col-sm-3">
<div>
<h3>Source Files</h3>
<ul><li><a href='sourcefile/abstractcollectivedatamessage.f90.html'>AbstractCollectiveDataMessage.F90</a></li><li><a href='sourcefile/abstractcolumn.f90.html'>AbstractColumn.F90</a></li><li><a href='sourcefile/abstractcommsplitter.f90.html'>AbstractCommSplitter.F90</a></li><li><a href='sourcefile/abstractcomponent.f90.html'>AbstractComponent.F90</a></li><li><a href='sourcefile/abstractcomposite.f90.html'>AbstractComposite.F90</a></li><li><a href='sourcefile/abstractdatamessage.f90.html'>AbstractDataMessage.F90</a></li><li><a href='sourcefile/abstractdatareference.f90.html'>AbstractDataReference.F90</a></li><li><a href='sourcefile/abstractdirectoryservice.f90.html'>AbstractDirectoryService.F90</a></li><li><a href='sourcefile/abstractframeworkcomponent.f90.html'>AbstractFrameworkComponent.F90</a></li><li><a href='sourcefile/abstractgauge.f90.html'>AbstractGauge.F90</a></li></ul>
</div>
<div>
<ul>
<li><a href="./lists/files.html"><em>All source files…</em></a></li>
</ul>
</div>
</div>
<div class="col-xs-6 col-sm-3">
<div>
<h3>Modules</h3>
<ul><li><a href='module/biniomod.html'>BinIOMod</a></li><li><a href='module/bundletestsupport.html'>BundleTestSupport</a></li><li><a href='module/collective_demo_cli.html'>collective_demo_CLI</a></li><li><a href='module/ctest_io_cli.html'>ctest_io_CLI</a></li><li><a href='module/esmf_cfiocollectionmod.html'>ESMF_CFIOCollectionMod</a></li><li><a href='module/esmf_cfiocollectionvectormod.html'>ESMF_CFIOCollectionVectorMod</a></li><li><a href='module/esmf_cfioeosmod.html'>ESMF_CFIOEosMod</a></li><li><a href='module/esmf_cfiofilemod.html'>ESMF_CFIOFileMod</a></li><li><a href='module/esmf_cfiogridmod.html'>ESMF_CFIOGridMod</a></li><li><a href='module/esmf_cfiomod.html'>ESMF_CFIOMod</a></li></ul>
</div>
<div>
<ul>
<li><a href="./lists/modules.html"><em>All modules…</em></a></li>
</ul>
</div>
</div>
<div class="col-xs-6 col-sm-3">
<div>
<h3>Procedures</h3>
<ul><li><a href='proc/abi_xy_2_lonlat.html'>ABI_XY_2_lonlat</a></li><li><a href='interface/abstractdatareferencevector.html'>AbstractDataReferenceVector</a></li><li><a href='interface/abstractsocketvector.html'>AbstractSocketVector</a></li><li><a href='proc/add_child_component.html'>add_child_component</a></li><li><a href='proc/add_cli_options.html'>add_cli_options</a></li><li><a href='proc/add_fvar.html'>add_fvar</a></li><li><a href='proc/add_new_field_to_bundle.html'>add_new_field_to_bundle</a></li><li><a href='interface/addextcollectionmessage.html'>AddExtCollectionMessage</a></li><li><a href='interface/addhistcollectionmessage.html'>AddHistCollectionMessage</a></li><li><a href='proc/addlist.html'>addList</a></li></ul>
</div>
<div>
<ul>
<li><a href="./lists/procedures.html"><em>All procedures…</em></a></li>
</ul>
</div>
</div>
<div class="col-xs-6 col-sm-3">
<div>
<h3>Derived Types</h3>
<ul><li><a href='type/abstractcollectivedatamessage.html'>AbstractCollectiveDataMessage</a></li><li><a href='type/abstractcolumn.html'>AbstractColumn</a></li><li><a href='type/abstractcommsplitter.html'>AbstractCommSplitter</a></li><li><a href='type/abstractcomponent.html'>AbstractComponent</a></li><li><a href='type/abstractcomposite.html'>AbstractComposite</a></li><li><a href='type/abstractdatamessage.html'>AbstractDataMessage</a></li><li><a href='type/abstractdatareference.html'>AbstractDataReference</a></li><li><a href='type/abstractdatareferencevector.html'>AbstractDataReferenceVector</a></li><li><a href='type/abstractdatareferencevectoriterator.html'>AbstractDataReferenceVectorIterator</a></li><li><a href='type/abstractdatareferencevectorriterator.html'>AbstractDataReferenceVectorRIterator</a></li></ul>
</div>
<div>
<ul>
<li><a href="./lists/types.html"><em>All derived types…</em></a></li>
</ul>
</div>
</div>
</div>
<hr>
</div> <!-- /container -->
<footer>
<div class="container">
<div class="row justify-content-between">
<div class="col">
<p>
MAPL
was developed by The MAPL Developers<br> © 2026
</p>
</div>
<div class="col">
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2026-04-13T20:30:45.513446+0000 </p>
</div>
</div>
<br>
</div> <!-- /container -->
</footer>
</body>
</html>