-
Notifications
You must be signed in to change notification settings - Fork 374
/
Copy pathconfig_component.xml
3128 lines (2787 loc) · 98.8 KB
/
config_component.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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="config_compsets.xsl" ?>
<entry_id version="2.0">
<!-- The list of component classes that this coupler/driver knows how
to deal with. Stub and data models for each component class
should be provided by the driver. This list should follow the same order
as compset longnames follows -->
<entry id="COMP_CLASSES">
<type>char</type>
<default_value>CPL,ATM,LND,ICE,OCN,ROF,GLC,WAV,IAC,ESP</default_value>
<file>env_case.xml</file>
<group>case_comp</group>
<desc>List of component classes supported by this driver</desc>
</entry>
<entry id="COMP_CPL">
<type>char</type>
<valid_values>cpl</valid_values>
<default_value>cpl</default_value>
<group>case_comp</group>
<file>env_case.xml</file>
<desc>Name of coupling component</desc>
</entry>
<!-- ===================================================================== -->
<!-- master configuration file that specifies all relevant filenames and -->
<!-- and directories to configure a case -->
<!-- ===================================================================== -->
<entry id="FILES_CONFIG_SPEC">
<type>char</type>
<default_value>$CIMEROOT/config_files.xml</default_value>
<group>case_def</group>
<file>env_case.xml</file>
<desc> master configuration file that specifies all relevant filenames
and directories to configure a case</desc>
</entry>
<!-- ===================================================================== -->
<!-- definitions case directories -->
<!-- ===================================================================== -->
<entry id="CASEROOT">
<type>char</type>
<default_value>UNSET</default_value>
<group>case_def</group>
<file>env_case.xml</file>
<desc>full pathname of case</desc>
</entry>
<entry id="NONLOCAL">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<default_value>FALSE</default_value>
<group>case_def</group>
<file>env_case.xml</file>
<desc>user is not on the requested machine</desc>
</entry>
<entry id="CASETOOLS">
<type>char</type>
<default_value>$CASEROOT/Tools</default_value>
<group>case_der</group>
<file>env_case.xml</file>
<desc>Case Tools directory location (derived variable, not in namelists</desc>
</entry>
<entry id="CASEBUILD">
<type>char</type>
<default_value>$CASEROOT/Buildconf</default_value>
<group>case_der</group>
<file>env_case.xml</file>
<desc>Buildconf directory location (derived variable not in namelist)</desc>
</entry>
<entry id="SCRIPTSROOT">
<type>char</type>
<default_value>$CIMEROOT/scripts</default_value>
<group>case_der</group>
<file>env_case.xml</file>
<desc>Scripts root directory location (setup automatically to $CIMEROOT/scripts- DO NOT EDIT)</desc>
</entry>
<entry id="CIMEROOT">
<type>char</type>
<default_value>UNSET</default_value>
<group>case_def</group>
<file>env_case.xml</file>
<desc>full pathname of CIME source root directory</desc>
</entry>
<entry id="SRCROOT">
<type>char</type>
<default_value>$CIMEROOT/..</default_value>
<group>case_def</group>
<file>env_case.xml</file>
<desc>full pathname of source root directory</desc>
</entry>
<entry id="UTILROOT">
<type>char</type>
<default_value>$CIMEROOT/CIME/Tools</default_value>
<group>case_der</group>
<file>env_case.xml</file>
<desc>Scripts root utils directory location (setup automatically to $CIMEROOT/CIME/Tools - DO NOT EDIT)</desc>
</entry>
<!-- ===================================================================== -->
<!-- definitions case -->
<!-- ===================================================================== -->
<entry id="CASE">
<type>char</type>
<default_value>UNSET</default_value>
<group>case_def</group>
<file>env_case.xml</file>
<desc>case name</desc>
</entry>
<entry id="CASESTR">
<type>char</type>
<default_value>UNSET</default_value>
<group>run_desc</group>
<file>env_run.xml</file>
<desc>case description</desc>
</entry>
<entry id="COMPSET">
<type>char</type>
<default_value>UNSET</default_value>
<group>case_last</group>
<file>env_case.xml</file>
<desc>Component set long name (for documentation only - DO NOT EDIT)</desc>
</entry>
<entry id="GRID">
<type>char</type>
<default_value>UNSET</default_value>
<group>build_grid</group>
<file>env_build.xml</file>
<desc>Model grid - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="SUPPORTED_BY">
<type>char</type>
<default_value>UNSET</default_value>
<group>case_def</group>
<file>env_case.xml</file>
<desc>current machine name support contact</desc>
</entry>
<entry id="USER">
<type>char</type>
<default_value>$ENV{USER}</default_value>
<group>case_desc</group>
<file>env_case.xml</file>
<desc>case user name</desc>
</entry>
<entry id="REALUSER">
<type>char</type>
<default_value>$ENV{USER}</default_value>
<group>case_desc</group>
<file>env_case.xml</file>
<desc>username of user who created case</desc>
</entry>
<entry id="CASE_GROUP">
<type>char</type>
<group>case_desc</group>
<file>env_case.xml</file>
<desc>
Optional string denoting that this case is part of a case group
</desc>
</entry>
<entry id="CASE_HASH">
<type>char</type>
<group>case_desc</group>
<file>env_case.xml</file>
<desc>Unique identifier for case</desc>
</entry>
<!-- ===================================================================== -->
<!-- definitions runtimes -->
<!-- ===================================================================== -->
<entry id="RUN_TYPE">
<type>char</type>
<valid_values>startup,hybrid,branch</valid_values>
<default_value>startup</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
Determines the model run initialization type.
This setting is only important for the initial run of a production run when the
CONTINUE_RUN variable is set to FALSE. After the initial run, the CONTINUE_RUN
variable is set to TRUE, and the model restarts exactly using input
files in a case, date, and bit-for-bit continuous fashion.
Default: startup.
-- In a startup run (the default), all components are initialized
using baseline states. These baseline states are set independently by
each component and can include the use of restart files, initial
files, external observed data files, or internal initialization (i.e.,
a cold start). In a startup run, the coupler sends the start date to
the components at initialization. In addition, the coupler does not
need an input data file. In a startup initialization, the ocean model
does not start until the second ocean coupling (normally the second
day).
-- In a branch run, all components are initialized using a consistent
set of restart files from a previous run (determined by the
RUN_REFCASE and RUN_REFDATE variables in env_run.xml). The case name
is generally changed for a branch run, although it does not have to
be. In a branch run, setting RUN_STARTDATE is ignored because the
model components obtain the start date from their restart datasets.
Therefore, the start date cannot be changed for a branch run. This is
the same mechanism that is used for performing a restart run (where
CONTINUE_RUN is set to TRUE in the env_run.xml) Branch runs are
typically used when sensitivity or parameter studies are required, or
when settings for history file output streams need to be modified
while still maintaining bit-for-bit reproducibility. Under this
scenario, the new case is able to produce an exact bit-for-bit restart
in the same manner as a continuation run IF no source code or
component namelist inputs are modified. All models use restart files
to perform this type of run. RUN_REFCASE and RUN_REFDATE are required
for branch runs.
To set up a branch run, locate the restart tar file or restart
directory for RUN_REFCASE and RUN_REFDATE from a previous run, then
place those files in the RUNDIR directory.
--- In a hybrid run the model is initialized as a startup, BUT uses
initialization datasets FROM A PREVIOUS case. This
is somewhat analogous to a branch run with relaxed restart
constraints. A hybrid run allows users to bring together combinations
of initial/restart files from a previous case (specified by
RUN_REFCASE) at a given model output date (specified by
RUN_REFDATE). Unlike a branch run, the starting date of a hybrid run
(specified by RUN_STARTDATE) can be modified relative to the reference
case. In a hybrid run, the model does not continue in a bit-for-bit
fashion with respect to the reference case. The resulting climate,
however, should be continuous provided that no model source code or
namelists are changed in the hybrid run. In a hybrid initialization,
the ocean model does not start until the second ocean coupling
(normally the second day), and the coupler does a cold start without
a restart file.
</desc>
</entry>
<entry id="RUN_REFDIR">
<type>char</type>
<default_value>cesm2_init</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
Reference directory containing RUN_REFCASE data - used for hybrid or branch runs
</desc>
</entry>
<entry id="RUN_REFCASE">
<type>char</type>
<default_value>case.std</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
Reference case for hybrid or branch runs
</desc>
</entry>
<entry id="RUN_REFDATE">
<type>char</type>
<default_value>0001-01-01</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
Reference date for hybrid or branch runs (yyyy-mm-dd)
</desc>
</entry>
<entry id="RUN_REFTOD">
<type>char</type>
<default_value>00000</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
Reference time of day (seconds) for hybrid or branch runs (sssss)
</desc>
</entry>
<entry id="GET_REFCASE">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<default_value>FALSE</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
Flag for automatically prestaging the refcase restart dataset.
If TRUE, then the refcase data is prestaged into the executable directory
</desc>
</entry>
<entry id="RUN_STARTDATE">
<type>char</type>
<default_value>0001-01-01</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
Run start date (yyyy-mm-dd). Only used for startup or hybrid runs.
</desc>
</entry>
<entry id="START_TOD">
<type>integer</type>
<default_value>0</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
Run start time-of-day
</desc>
</entry>
<entry id="STOP_OPTION">
<type>char</type>
<valid_values>none,never,nsteps,nstep,nseconds,nsecond,nminutes,nminute,nhours,nhour,ndays,nday,nmonths,nmonth,nyears,nyear,date,ifdays0,end</valid_values>
<default_value>ndays</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
Sets the run length along with STOP_N and STOP_DATE
</desc>
</entry>
<entry id="STOP_N">
<type>integer</type>
<default_value>5</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
Provides a numerical count for $STOP_OPTION.
</desc>
</entry>
<entry id="STOP_DATE">
<type>integer</type>
<default_value>-999</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
Alternative date yyyymmdd date option, sets the run length with STOP_OPTION and STOP_N
negative value implies off
</desc>
</entry>
<entry id="REST_OPTION">
<type>char</type>
<valid_values>none,never,nsteps,nstep,nseconds,nsecond,nminutes,nminute,nhours,nhour,ndays,nday,nmonths,nmonth,nyears,nyear,date,ifdays0,end</valid_values>
<default_value>$STOP_OPTION</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
sets frequency of model restart writes (same options as STOP_OPTION)
</desc>
</entry>
<entry id="REST_N">
<type>integer</type>
<default_value>$STOP_N</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
sets model restart writes with REST_OPTION and REST_DATE
</desc>
</entry>
<entry id="REST_DATE">
<type>char</type>
<default_value>$STOP_DATE</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
Alternative date in yyyymmdd format
sets model restart write date with REST_OPTION and REST_N
</desc>
</entry>
<entry id="PAUSE_OPTION">
<type>char</type>
<valid_values>none,never,nsteps,nstep,nseconds,nsecond,nminutes,nminute,nhours,nhour,ndays,nday,nmonths,nmonth,nyears,nyear</valid_values>
<default_value>never</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
Sets the pause frequency along with PAUSE_N
</desc>
</entry>
<entry id="PAUSE_N">
<type>integer</type>
<default_value>0</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
Provides a numerical count for $PAUSE_OPTION.
</desc>
</entry>
<entry id="PAUSE_ACTIVE">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
Pause the model at times specified by PAUSE_OPTION and PAUSE_N.
Components 'pause' by writing a restart file.
</desc>
<values>
<value compclass="ATM">FALSE</value>
<value compclass="CPL">FALSE</value>
<value compclass="OCN">FALSE</value>
<value compclass="WAV">FALSE</value>
<value compclass="GLC">FALSE</value>
<value compclass="ICE">FALSE</value>
<value compclass="ROF">FALSE</value>
<value compclass="LND">FALSE</value>
<value compclass="IAC">FALSE</value>
</values>
</entry>
<entry id="BARRIER_N">
<type>char</type>
<default_value>1</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
Sets periodic model barriers with BARRIER_OPTION and BARRIER_DATE for synchronization
</desc>
</entry>
<entry id="BARRIER_DATE">
<type>char</type>
<default_value>-999</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
Alternative date in yyyymmdd format
sets periodic model barriers with BARRIER_OPTION and BARRIER_N for synchronization
</desc>
</entry>
<entry id="ESP_RUN_ON_PAUSE">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<default_value>FALSE</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
ESP component runs after driver 'pause cycle' If any component
'pauses' (see PAUSE_OPTION,
PAUSE_N and PAUSE_ACTIVE_XXX XML variables),
the ESP component (if present) will be run to process the
component 'pause' (restart) files and set any required 'resume'
signals. If true, esp_cpl_dt and esp_cpl_offset settings are
ignored. default: false
</desc>
</entry>
<entry id="CONTINUE_RUN">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<default_value>FALSE</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>
A setting of TRUE implies a continuation run
When you first begin a branch, hybrid or startup run, CONTINUE_RUN
must be set to FALSE. When you successfully run and get a restart
file, you will need to change CONTINUE_RUN to TRUE for the remainder
of your run. This variable determines if the run is a restart run.
Set to FALSE when initializing a startup, branch or hybrid case.
Set to TRUE when continuing a run.
</desc>
</entry>
<entry id="RESUBMIT">
<type>integer</type>
<default_value>0</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>If RESUBMIT is greater than 0, then case will automatically resubmit
Enables the model to automatically resubmit a new run. To get
multiple runs, set RESUBMIT greater than 0, then RESUBMIT will be
decremented and the case will be resubmitted. The case will stop automatically
resubmitting when the RESUBMIT value reaches 0.
Long runs can easily outstrip supercomputer queue time limits. For
this reason, a case is usually run as a series of jobs, each
restarting where the previous finished.
</desc>
</entry>
<entry id="RESUBMIT_SETS_CONTINUE_RUN">
<type>logical</type>
<default_value>TRUE</default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>This flag controls whether the RESUBMIT flag causes
CONTINUE_RUN to toggle from FALSE to TRUE. The default is
TRUE. This flag might be used in conjunction with COMP_RUN_BARRIERS for
timing tests.
</desc>
</entry>
<entry id="JOB_IDS">
<type>char</type>
<default_value></default_value>
<group>run_begin_stop_restart</group>
<file>env_run.xml</file>
<desc>List of job ids for most recent case.submit</desc>
</entry>
<!-- ===================================================================== -->
<!-- definitions archive -->
<!-- ===================================================================== -->
<entry id="DOUT_S">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<default_value>FALSE</default_value>
<group>run_data_archive</group>
<file>env_run.xml</file>
<desc>Logical to turn on short term archiving.
If TRUE, short term archiving will be turned on.</desc>
</entry>
<entry id="SYSLOG_N">
<type>integer</type>
<default_value>900</default_value>
<group>run_data_archive</group>
<file>env_run.xml</file>
<desc>system workload snapshot frequency (in seconds, if greater than 0; disabled otherwise)</desc>
</entry>
<!-- ===================================================================== -->
<!-- definitions machines specific -->
<!-- ===================================================================== -->
<entry id="environment_variables">
<type>char</type>
<default_value>UNSET</default_value>
<group>config_batch</group>
<file>env_mach_specific.xml</file>
<desc>The environment variables that will be loaded for this machine</desc>
</entry>
<entry id="BATCH_SYSTEM">
<type>char</type>
<default_value>none</default_value>
<valid_values>miller_slurm,nersc_slurm,lc_slurm,moab,pbs,pbspro,lsf,slurm,cobalt,cobalt_theta,slurm_single_node,none</valid_values>
<group>config_batch</group>
<file>env_batch.xml</file>
<desc>The batch system type to use for this machine.</desc>
</entry>
<entry id="env">
<type>char</type>
<default_value>UNSET</default_value>
<group>config_batch</group>
<file>env_mach_specific.xml</file>
<desc>The individual environment variable entry for config_machines</desc>
</entry>
<entry id="limits">
<type>char</type>
<default_value>UNSET</default_value>
<group>config_batch</group>
<file>env_mach_specific.xml</file>
<desc>The limits tag</desc>
</entry>
<entry id="limit">
<type>char</type>
<default_value>UNSET</default_value>
<group>config_batch</group>
<file>env_mach_specific.xml</file>
<desc>The individual limit variable</desc>
</entry>
<!-- ===================================================================== -->
<!-- definitions batch -->
<!-- ===================================================================== -->
<entry id="PERL5LIB">
<type>char</type>
<default_value></default_value>
<group>build_derived</group>
<file>env_build.xml</file>
<desc>Perl 5 library directory</desc>
</entry>
<!-- ===================================================================== -->
<!-- definitions build -->
<!-- ===================================================================== -->
<entry id="CIME_OUTPUT_ROOT">
<type>char</type>
<valid_values></valid_values>
<default_value>UNSET</default_value>
<group>build_def</group>
<file>env_build.xml</file>
<desc>Output root directory for each machine.
Base directory for build and run directories.
</desc>
</entry>
<entry id="EXEROOT">
<type>char</type>
<valid_values></valid_values>
<default_value>$CIME_OUTPUT_ROOT/$CASE/bld</default_value>
<group>build_def</group>
<file>env_build.xml</file>
<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="OS">
<type>char</type>
<valid_values></valid_values>
<default_value>USERDEFINED_required_macros</default_value>
<group>build_macros</group>
<file>env_build.xml</file>
<desc>Operating system - DO NOT EDIT UNLESS for userdefined machine - ignored once Macros has been created.</desc>
</entry>
<entry id="COMPILER">
<type>char</type>
<valid_values></valid_values>
<default_value></default_value>
<group>build_macros</group>
<file>env_build.xml</file>
<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">
<type>char</type>
<valid_values></valid_values>
<default_value>USERDEFINED_required_macros</default_value>
<group>build_macros</group>
<file>env_build.xml</file>
<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="CALENDAR">
<type>char</type>
<valid_values>NO_LEAP,GREGORIAN</valid_values>
<default_value>NO_LEAP</default_value>
<group>build_def</group>
<file>env_build.xml</file>
<desc>calendar type</desc>
</entry>
<entry id="COMP_INTERFACE">
<type>char</type>
<valid_values>mct,nuopc,moab</valid_values>
<default_value>mct</default_value>
<group>build_def</group>
<file>env_build.xml</file>
<desc>use MCT component interface</desc>
</entry>
<entry id="USE_ESMF_LIB">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<default_value>FALSE</default_value>
<group>build_def</group>
<file>env_build.xml</file>
<desc>TRUE implies using the ESMF library specified by ESMF_LIBDIR or ESMFMKFILE</desc>
</entry>
<entry id="DEBUG">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<default_value>FALSE</default_value>
<group>build_def</group>
<file>env_build.xml</file>
<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="FORCE_BUILD_SMP">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<default_value>FALSE</default_value>
<group>build_def</group>
<file>env_build.xml</file>
<desc>TRUE implies always build model for openmp capability
If FALSE, component libraries are built with OpenMP capability if
the NTHREADS_ setting for any 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="BUILD_THREADED">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<default_value>FALSE</default_value>
<group>build_def</group>
<file>env_build.xml</file>
<desc>TRUE implies that at least one of the components is built threaded (DO NOT EDIT)</desc>
</entry>
<entry id="USE_PETSC">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<default_value>FALSE</default_value>
<group>build_def</group>
<file>env_build.xml</file>
<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">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<default_value>FALSE</default_value>
<group>build_def</group>
<file>env_build.xml</file>
<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
MALI. Note that Albany is a C++ library, so setting this
variable to TRUE will involve the inclusion of C++ code in the
MALI executable. This is currently only supported for certain
machines.</desc>
</entry>
<entry id="USE_TRILINOS">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<default_value>FALSE</default_value>
<group>build_def</group>
<file>env_build.xml</file>
<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>
<entry id="GMAKE">
<type>char</type>
<valid_values></valid_values>
<default_value>gmake</default_value>
<group>build_def</group>
<file>env_run.xml</file>
<desc>GNU make command</desc>
</entry>
<entry id="GMAKE_J">
<type>integer</type>
<valid_values></valid_values>
<default_value>1</default_value>
<group>build_def</group>
<file>env_run.xml</file>
<desc>Number of processors for gmake</desc>
</entry>
<entry id="BUILD_COMPLETE">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<default_value>FALSE</default_value>
<group>build_status</group>
<file>env_build.xml</file>
<desc>Status output: if TRUE, models have been built successfully. (DO NOT EDIT)></desc>
</entry>
<entry id="SMP_BUILD">
<type>char</type>
<valid_values></valid_values>
<default_value>0</default_value>
<group>build_status</group>
<file>env_build.xml</file>
<desc>Status: smp status of previous build, coded string. (DO NOT EDIT)</desc>
</entry>
<entry id="SMP_VALUE">
<type>char</type>
<valid_values></valid_values>
<default_value>0</default_value>
<group>build_status</group>
<file>env_build.xml</file>
<desc>Status: smp status of current case, coded string (DO NOT EDIT)</desc>
</entry>
<entry id="NINST_BUILD">
<type>char</type>
<valid_values></valid_values>
<default_value>0</default_value>
<group>build_status</group>
<file>env_build.xml</file>
<desc>Status: ninst status of previous build, coded string. (DO NOT EDIT)></desc>
</entry>
<entry id="NINST_VALUE">
<type>char</type>
<valid_values></valid_values>
<default_value>0</default_value>
<group>build_status</group>
<file>env_build.xml</file>
<desc>Status: ninst status of current case, coded string (DO NOT EDIT)</desc>
</entry>
<entry id="BUILD_STATUS">
<type>integer</type>
<valid_values>0,1,2</valid_values>
<default_value>0</default_value>
<group>build_status</group>
<file>env_build.xml</file>
<desc>Status: of prior build. (DO NOT EDIT)</desc>
</entry>
<entry id="OBJROOT">
<type>char</type>
<valid_values></valid_values>
<default_value>$EXEROOT</default_value>
<group>build_derived</group>
<file>env_build.xml</file>
<desc>case build directory (set automatically to $EXEROOT, - DO NOT EDIT)</desc>
</entry>
<entry id="LIBROOT">
<type>char</type>
<valid_values></valid_values>
<default_value>$EXEROOT/lib</default_value>
<group>build_derived</group>
<file>env_build.xml</file>
<desc>case lib directory (set automatically to $EXEROOT/lib - DO NOT EDIT)</desc>
</entry>
<entry id="INCROOT">
<type>char</type>
<valid_values></valid_values>
<default_value>$EXEROOT/lib/include</default_value>
<group>build_derived</group>
<file>env_build.xml</file>
<desc>case lib include directory (set automatically to $EXEROOT/lib/include - DO NOT EDIT)</desc>
</entry>
<entry id="SHAREDLIBROOT">
<type>char</type>
<valid_values></valid_values>
<default_value>$EXEROOT</default_value>
<group>build_derived</group>
<file>env_build.xml</file>
<desc>Shared library root, (set automatically to $EXEROOT - DO NOT EDIT)</desc>
</entry>
<!-- ===================================================================== -->
<!-- definitions performance -->
<!-- ===================================================================== -->
<entry id="CHECK_TIMING">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<default_value>TRUE</default_value>
<group>run_flags</group>
<file>env_run.xml</file>
<desc>logical to diagnose model timing at the end of the run</desc>
</entry>
<entry id="TEST_MEMLEAK_TOLERANCE">
<type>real</type>
<default_value>0.10</default_value>
<group>run_flags</group>
<file>env_run.xml</file>
<desc>Expected relative memory usage growth for test</desc>
</entry>
<entry id="TEST_TPUT_TOLERANCE">
<type>real</type>
<default_value>0.25</default_value>
<group>run_flags</group>
<file>env_run.xml</file>
<desc>Expected throughput deviation</desc>
</entry>
<entry id="PROFILE_PAPI_ENABLE">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<default_value>FALSE</default_value>
<group>run_flags</group>
<file>env_run.xml</file>
<desc>Enables the papi hardware counters in gptl
The papi library must be included in the build step for
this to work.</desc>
</entry>
<entry id="ESMF_LOGFILE_KIND">
<type>char</type>
<valid_values>ESMF_LOGKIND_SINGLE,ESMF_LOGKIND_MULTI,ESMF_LOGKIND_MULTI_ON_ERROR,ESMF_LOGKIND_NONE</valid_values>
<default_value>ESMF_LOGKIND_NONE</default_value>
<group>run_flags</group>
<file>env_run.xml</file>
<desc>
Determines what ESMF log files (if any) are generated when
USE_ESMF_LIB is TRUE.
ESMF_LOGKIND_SINGLE: Use a single log file, combining messages from
all of the PETs. Not supported on some platforms.
ESMF_LOGKIND_MULTI: Use multiple log files -- one per PET.
ESMF_LOGKIND_NONE: Do not issue messages to a log file.
By default, no ESMF log files are generated.
</desc>
</entry>
<entry id="COMP_RUN_BARRIERS">
<type>logical</type>
<valid_values>TRUE,FALSE</valid_values>
<default_value>FALSE</default_value>
<group>run_flags</group>
<file>env_run.xml</file>
<desc>Turns on component barriers for component timing.
This variable is for testing and debugging only and should never
be set for a production run.
</desc>
</entry>
<entry id="COST_PES">
<type>integer</type>
<default_value>0</default_value>
<group>mach_pes_last</group>
<file>env_mach_pes.xml</file>
<desc>pes or cores used relative to MAX_MPITASKS_PER_NODE for accounting (0 means TOTALPES is valid)</desc>
</entry>
<!-- ===================================================================== -->
<!-- definitions grid -->
<!-- ===================================================================== -->
<entry id="ATM_GRID">
<type>char</type>
<default_value>UNSET</default_value>
<group>build_grid</group>
<file>env_build.xml</file>
<desc>atmosphere grid - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="ATM_NX">
<type>integer</type>
<default_value>0</default_value>
<group>build_grid</group>
<file>env_build.xml</file>
<desc>number of atmosphere cells in i direction - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="ATM_NY">
<type>integer</type>
<default_value>0</default_value>
<group>build_grid</group>
<file>env_build.xml</file>
<desc>number of atmosphere cells in j direction - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="LND_GRID">
<type>char</type>
<default_value>UNSET</default_value>
<group>build_grid</group>
<file>env_build.xml</file>
<desc>land grid - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="LND_NX">
<type>integer</type>
<default_value>0</default_value>
<group>build_grid</group>
<file>env_build.xml</file>
<desc>number of land cells in i direction - DO NOT EDIT (for experts only)</desc>
</entry>
<entry id="LND_NY">
<type>integer</type>
<default_value>0</default_value>