-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathenv_build.xml
333 lines (333 loc) · 13.7 KB
/
env_build.xml
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
<?xml version="1.0"?>
<file id="env_build.xml" version="2.0">
<header>
These variables SHOULD NOT be changed once the model has been built.
urrently, these variables are not cached.
Note1: users SHOULD NOT modify BUILD_COMPETE below
this is done automatically by the scripts.
</header>
<group id="build_grid">
<entry id="GRID" value="a%1.9x2.5_l%1.9x2.5_oi%gx1v7_r%r05_g%gris4_w%ww3a_z%null_m%gx1v7">
<type>char</type>
<desc>Model grid - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="ATM_GRID" value="1.9x2.5">
<type>char</type>
<desc>atmosphere grid - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="ATM_NX" value="144">
<type>integer</type>
<desc>number of atmosphere cells in i direction - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="ATM_NY" value="96">
<type>integer</type>
<desc>number of atmosphere cells in j direction - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="LND_GRID" value="1.9x2.5">
<type>char</type>
<desc>land grid - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="LND_NX" value="144">
<type>integer</type>
<desc>number of land cells in i direction - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="LND_NY" value="96">
<type>integer</type>
<desc>number of land cells in j direction - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="OCN_GRID" value="gx1v7">
<type>char</type>
<desc>ocn grid - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="OCN_NX" value="320">
<type>integer</type>
<desc>number of ocn cells in i direction - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="OCN_NY" value="384">
<type>integer</type>
<desc>number of ocn cells in j direction - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="ICE_GRID" value="gx1v7">
<type>char</type>
<desc>ice grid (must equal ocn grid) - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="ICE_NX" value="320">
<type>integer</type>
<desc>number of ice cells in i direction - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="ICE_NY" value="384">
<type>integer</type>
<desc>number of ice cells in j direction - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="ICE_NCAT" value="1">
<type>integer</type>
<desc>number of ice thickness categories - DO NOT EDIT (set by CICE configure)</desc>
</entry>
<entry id="ROF_GRID" value="r05">
<type>char</type>
<desc>river runoff (rof) grid</desc>
</entry>
<entry id="ROF_NX" value="720">
<type>integer</type>
<desc>number of rof cells in i direction - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="ROF_NY" value="360">
<type>integer</type>
<desc>number of rof cells in j direction - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="GLC_GRID" value="gris4">
<type>char</type>
<desc>glacier (glc) grid - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="GLC_NX" value="416">
<type>integer</type>
<desc>number of glc cells in i direction - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="GLC_NY" value="704">
<type>integer</type>
<desc>number of glc cells in j direction - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="WAV_GRID" value="ww3a">
<type>char</type>
<desc>wave model (wav) grid</desc>
</entry>
<entry id="WAV_NX" value="90">
<type>integer</type>
<desc>number of wav cells in i direction - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="WAV_NY" value="50">
<type>integer</type>
<desc>number of wav cells in j direction - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="MASK_GRID" value="gx1v7">
<type>char</type>
<desc>grid mask - DO NOT EDIT (for experts only)</desc>
</entry>
</group>
<group id="build_derived">
<entry id="PERL5LIB">
<type>char</type>
<desc>Perl 5 library directory</desc>
</entry>
<entry id="OBJROOT" value="$EXEROOT">
<type>char</type>
<valid_values/>
<desc>case build directory (set automatically to $EXEROOT, - DO NOT EDIT)</desc>
</entry>
<entry id="LIBROOT" value="$EXEROOT/lib">
<type>char</type>
<valid_values/>
<desc>case lib directory (set automatically to $EXEROOT/lib - DO NOT EDIT)</desc>
</entry>
<entry id="INCROOT" value="$EXEROOT/lib/include">
<type>char</type>
<valid_values/>
<desc>case lib include directory (set automatically to $EXEROOT/lib/include - DO NOT EDIT)</desc>
</entry>
<entry id="SHAREDLIBROOT" value="$EXEROOT">
<type>char</type>
<valid_values/>
<desc>Shared library root, (set automatically to $EXEROOT - DO NOT EDIT)</desc>
</entry>
</group>
<group id="build_def">
<entry id="CIME_OUTPUT_ROOT" value="/glade/derecho/scratch/jedwards">
<type>char</type>
<valid_values/>
<desc>Output root directory for each machine.
Base directory for build and run directories.
</desc>
</entry>
<entry id="EXEROOT" value="$CIME_OUTPUT_ROOT/$CASE/bld">
<type>char</type>
<valid_values/>
<desc>Case executable root directory.
(executable is $EXEROOT/$MODEL.exe, component libraries are in $EXEROOT/lib)
This is where the model builds its executable and by default runs the executable.
Note that EXEROOT needs to have enough disk space for the experimental configuration
requirements. As an example, a model run can produce more than a terabyte of
data during a 100-year run, so you should set EXEROOT to scratch or
tmp space and frequently back up the data to a long term archiving storage device
For a supported machine, EXEROOT is set in $CIMEROOT/machines/config_machines.xml.
For a userdefined machine, EXEROOT must explicitly be set it in env_build.xml.</desc>
</entry>
<entry id="SUPPORTED_BY">
<type>char</type>
<valid_values/>
<desc>email address of person (or group) that supports the build and port for this machine (do not edit)></desc>
</entry>
<entry id="CALENDAR" value="NO_LEAP">
<type>char</type>
<valid_values>NO_LEAP,GREGORIAN</valid_values>
<desc>calendar type</desc>
</entry>
<entry id="COMP_INTERFACE" value="nuopc">
<type>char</type>
<valid_values>nuopc</valid_values>
<desc>use NUOPC component interface</desc>
</entry>
<entry id="USE_ESMF_LIB" value="TRUE">
<type>logical</type>
<valid_values>TRUE</valid_values>
<desc>TRUE implies using the ESMF library specified by ESMF_LIBDIR or ESMFMKFILE</desc>
</entry>
<entry id="DEBUG" value="FALSE">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<desc>TRUE implies turning on run and compile time debugging
Flag to turn on debugging for run time and compile time.
If TRUE, compile-time debugging flags are activated that you can use to verify
software robustness, such as bounds checking.
Important:: On IBM machines, floating point trapping is not activated for production
runs (i.e., non-DEBUG), due to performance penalties associated with turning on these flags.</desc>
</entry>
<entry id="BUILD_THREADED" value="FALSE">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<desc>TRUE implies always build model for openmp capability
If FALSE, component libraries are built with OpenMP capability only if
the NTHREADS_ setting for that component is greater than 1 in env_mach_pes.xml.
If TRUE, the component libraries are always built with OpenMP capability.</desc>
</entry>
<entry id="FORCE_BUILD_SMP" value="FALSE">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<desc>TRUE implies always build model for openmp capability
If FALSE, component libraries are built with OpenMP capability only if
the NTHREADS_ setting for that component is greater than 1 in env_mach_pes.xml.
If TRUE, the component libraries are always built with OpenMP capability.</desc>
</entry>
<entry id="GPU_TYPE" value="none">
<type>char</type>
<valid_values/>
<desc>If set will compile and submit with this gpu type enabled </desc>
</entry>
<entry id="GPU_OFFLOAD" value="none">
<type>char</type>
<valid_values/>
<desc>If set will compile and submit with this gpu offload method enabled </desc>
</entry>
<entry id="MPI_GPU_WRAPPER_SCRIPT" value="set_gpu_rank">
<type>char</type>
<valid_values/>
<desc>If set will attach this script to the MPI run command, mapping
different MPI ranks to different GPUs within the same compute node</desc>
</entry>
<entry id="USE_PETSC" value="FALSE">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<desc>TRUE implies linking to the PETSc library - set
automatically by XXX_USE_PETSC options (do not edit). Flag to turn
on linking to the PETSc library. Currently this is used by
CLM. This is currently only supported for certain machines.</desc>
</entry>
<entry id="USE_ALBANY" value="FALSE">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<desc>TRUE implies linking to the Albany library - set
automatically by XXX_USE_ALBANY options (do not edit). Flag to
turn on linking to the Albany library. Currently this is used by
MPASLI. Note that Albany is a C++ library, so setting this
variable to TRUE will involve the inclusion of C++ code in the
MPASLI executable. This is currently only supported for certain
machines.</desc>
</entry>
<entry id="USE_MOAB" value="FALSE">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<desc>TRUE implies linking to the MOAB library</desc>
</entry>
<entry id="USE_TRILINOS" value="FALSE">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<desc>TRUE implies linking to the trilinos library - set automatically by XXX_USE_TRILINOS options (do not edit)
Flag to turn on linking to the trilinos library. Currently this is
used by CISM. Note that trilinos is a C++ library, so setting this
variable to TRUE will involve the inclusion of C++ code in the model
executable. This is currently only supported for certain machines.</desc>
</entry>
</group>
<group id="build_macros">
<entry id="OS" value="CNL">
<type>char</type>
<valid_values/>
<desc>Operating system - DO NOT EDIT UNLESS for userdefined machine - ignored once Macros has been created.</desc>
</entry>
<entry id="COMPILER" value="intel">
<type>char</type>
<valid_values/>
<desc>Machine compiler (must match one the supported compilers)
Set in $CIMEROOT/machines/config_machines.xml for each supported machine.
Must be explicitly set in env_build.xml for userdefined machine.</desc>
</entry>
<entry id="MPILIB" value="mpich">
<type>char</type>
<valid_values/>
<desc>mpi library (must match one of the supported libraries) -
ignored once Macros has been created
Set in $CIMEROOT/machines/config_machines.xml for each supported machine.
Must be explicitly set in env_build.xml for userdefined machine.</desc>
</entry>
<entry id="PIO_VERSION" value="2">
<type>integer</type>
<valid_values>1,2</valid_values>
<desc>PIO library version</desc>
</entry>
<entry id="PIO_CONFIG_OPTS">
<type>char</type>
<desc>PIO configure options, see PIO configure utility for details</desc>
</entry>
</group>
<group id="build_component_clm">
<entry id="CLM_USE_PETSC" value="FALSE">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<desc>TRUE implies CLM is built with support for the PETSc
library. The Variably Saturated Flow Model (VSFM) solver in CLM
uses the PETSc library. In order to use the VSFM solver, CLM
must be built with PETSc support and linking to PETSc must occur
when building the ACME executable. This occurs if this variable
is set to TRUE. Note that is only available on a limited set of
machines/compilers.</desc>
</entry>
</group>
<group id="build_status">
<entry id="BUILD_COMPLETE" value="FALSE">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<desc>Status output: if TRUE, models have been built successfully. (DO NOT EDIT)></desc>
</entry>
<entry id="SMP_BUILD" value="0">
<type>char</type>
<valid_values/>
<desc>Status: smp status of previous build, coded string. (DO NOT EDIT)</desc>
</entry>
<entry id="SMP_VALUE" value="0">
<type>char</type>
<valid_values/>
<desc>Status: smp status of current case, coded string (DO NOT EDIT)</desc>
</entry>
<entry id="NINST_BUILD" value="0">
<type>char</type>
<valid_values/>
<desc>Status: ninst status of previous build, coded string. (DO NOT EDIT)></desc>
</entry>
<entry id="NINST_VALUE" value="0">
<type>char</type>
<valid_values/>
<desc>Status: ninst status of current case, coded string (DO NOT EDIT)</desc>
</entry>
<entry id="BUILD_STATUS" value="0">
<type>integer</type>
<valid_values>0,1,2</valid_values>
<desc>Status: of prior build. (DO NOT EDIT)</desc>
</entry>
</group>
<group id="build_component_xrof">
<entry id="XROF_FLOOD_MODE" value="ACTIVE">
<type>char</type>
<valid_values>ACTIVE,NULL</valid_values>
<desc>mode for xrof flood feature, NULL means xrof flood is turned off</desc>
</entry>
</group>
</file>