forked from MPAS-Dev/MPAS-Analysis
-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.template
383 lines (322 loc) · 15.3 KB
/
config.template
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
[runs]
## options related to the run to be analyzed and reference runs to be
## compared against
# mainRunName is a name that identifies the simulation being analyzed.
mainRunName = runName
# referenceRunName is the name of a reference run to compare against (or None
# to turn off comparison with a reference, e.g. if no reference case is
# available)
referenceRunName = None
# preprocessedReferenceRunName is the name of a reference run that has been
# preprocessed to compare against (or None to turn off comparison). Reference
# runs of this type would have preprocessed results because they were not
# performed with MPAS components (so they cannot be easily ingested by
# MPAS-Analysis)
preprocessedReferenceRunName = None
[input]
## options related to reading in the results to be analyzed
# directory containing model results
baseDirectory = /dir/to/model/output
# names of namelist and streams files. If not in baseDirectory, give full path
oceanNamelistFileName = mpas-o_in
oceanStreamsFileName = streams.ocean
seaIceNamelistFileName = mpas-cice_in
seaIceStreamsFileName = streams.cice
[output]
## options related to writing out plots, intermediate cached data sets, logs,
## etc.
# directory where analysis should be written
baseDirectory = /dir/to/analysis/output
# subdirectories within baseDirectory for analysis output
scratchSubdirectory = scratch
plotsSubdirectory = plots
logsSubdirectory = logs
climatologySubdirectory = clim
# a list of analyses to generate. Valid names are:
# 'timeSeriesOHC', 'timeSeriesSST', 'regriddedSST',
# 'regriddedSSS', 'regriddedMLD', 'timeSeriesSeaIceAreaVol',
# 'regriddedSeaIceConcThick'
# the following shortcuts exist:
# 'all' -- all analyses will be run
# 'all_timeSeries' -- all time-series analyses will be run
# 'all_regriddedHorizontal' -- all analyses involving regridded horizontal
# fields will be run
# 'all_ocean' -- all ocean analyses will be run
# 'all_seaIce' -- all sea-ice analyses will be run
# 'no_timeSeriesOHC' -- skip 'timeSeriesOHC' (and similarly with the
# other analyses).
# 'no_ocean', 'no_timeSeries', etc. -- in analogy to 'all_*', skip the
# given category of analysis
# an equivalent syntax can be used on the command line to override this
# option:
# ./run_analysis.py config.analysis --generate \
# all,no_ocean,all_timeSeries
generate = ['all']
# alternative examples that would perform all analysis except
# 'timeSeriesOHC'
#generate = ['timeSeriesSST', 'all_regriddedHorizontal', 'all_seaIce']
#generate = ['all', 'no_timeSeriesOHC']
# Each subsequent list entry can be used to alter previous list entries. For
# example, the following would produce all analyses except regriddedSST,
# regriddedSSS and regriddedMLD (albeit not in a very intuitive way):
#generate = ['all', 'no_ocean', 'all_timeSeries']
[climatology]
## options related to producing climatologies, typically to compare against
## observations and previous runs
# the first year over which to average climatalogies
startYear = 11
# the last year over which to average climatalogies
endYear = 20
[timeSeries]
## options related to producing time series plots, often to compare against
## observations and previous runs
# start and end years for timeseries analysis. Using out-of-bounds values
# like start_year = 1 and end_year = 9999 will be clipped to the valid range
# of years, and is a good way of insuring that all values are used.
startYear = 1
endYear = 9999
[oceanObservations]
## options related to ocean observations with which the results will be compared
# directory where ocean observations are stored
baseDirectory = /dir/to/ocean/observations
sstSubdirectory = SST
sssSubdirectory = SSS
mldSubdirectory = MLD
# first and last year of SST observational climatology (preferably one of the
# two ranges given below)
# values for preindustrial
sstClimatologyStartYear = 1870
sstClimatologyEndYear = 1900
# alternative values for present day
#sstClimatologyStartYear = 1990
#sstClimatologyEndYear = 2011
[oceanReference]
## options related to ocean reference run with which the results will be
## compared
# directory where ocean reference simulation results are stored
baseDirectory = /dir/to/ocean/reference
[oceanPreprocessedReference]
## options related to preprocessed ocean reference run with which the results
## will be compared (e.g. a POP, CESM or ACME v0 run)
# directory where ocean reference simulation results are stored
baseDirectory = /dir/to/ocean/reference
[seaIceObservations]
## options related to sea ice observations with which the results will be
## compared
# directory where sea ice observations are stored
baseDirectory = /dir/to/seaice/observations
areaNH = IceArea_timeseries/iceAreaNH_climo.nc
areaSH = IceArea_timeseries/iceAreaSH_climo.nc
volNH = PIOMAS/PIOMASvolume_monthly_climo.nc
volSH = none
concentrationNASATeamNH_JFM = SSMI/NASATeam_NSIDC0051/SSMI_NASATeam_gridded_concentration_NH_jfm.interp0.5x0.5.nc
concentrationNASATeamNH_JAS = SSMI/NASATeam_NSIDC0051/SSMI_NASATeam_gridded_concentration_NH_jas.interp0.5x0.5.nc
concentrationNASATeamSH_DJF = SSMI/NASATeam_NSIDC0051/SSMI_NASATeam_gridded_concentration_SH_djf.interp0.5x0.5.nc
concentrationNASATeamSH_JJA = SSMI/NASATeam_NSIDC0051/SSMI_NASATeam_gridded_concentration_SH_jja.interp0.5x0.5.nc
concentrationBootstrapNH_JFM = SSMI/Bootstrap_NSIDC0079/SSMI_Bootstrap_gridded_concentration_NH_jfm.interp0.5x0.5.nc
concentrationBootstrapNH_JAS = SSMI/Bootstrap_NSIDC0079/SSMI_Bootstrap_gridded_concentration_NH_jas.interp0.5x0.5.nc
concentrationBootstrapSH_DJF = SSMI/Bootstrap_NSIDC0079/SSMI_Bootstrap_gridded_concentration_SH_djf.interp0.5x0.5.nc
concentrationBootstrapSH_JJA = SSMI/Bootstrap_NSIDC0079/SSMI_Bootstrap_gridded_concentration_SH_jja.interp0.5x0.5.nc
thicknessNH_ON = ICESat/ICESat_gridded_mean_thickness_NH_on.interp0.5x0.5.nc
thicknessNH_FM = ICESat/ICESat_gridded_mean_thickness_NH_fm.interp0.5x0.5.nc
thicknessSH_ON = ICESat/ICESat_gridded_mean_thickness_SH_on.interp0.5x0.5.nc
thicknessSH_FM = ICESat/ICESat_gridded_mean_thickness_SH_fm.interp0.5x0.5.nc
[seaIceReference]
## options related to sea ice reference run with which the results will be
## compared
# directory where sea ice reference simulation results are stored
baseDirectory = /dir/to/seaice/reference
[seaIcePreprocessedReference]
## options related to preprocessed sea ice reference run with which the results
## will be compared (e.g. a CICE, CESM or ACME v0 run)
# directory where ocean reference simulation results are stored
baseDirectory = /dir/to/seaice/reference
[remapping]
## options related to horizontal remapping
# paths to mapping files (which will hopefully be eliminated soon)
mpasRemapFile = /global/project/projectdirs/acme/mapping/maps/map_oEC60to30_TO_0.5x0.5degree_blin.160412.nc
[timeSeriesOHC]
## options related to plotting time series of ocean heat content (OHC)
## compare to output from another model run?
#compareWithModel = True
# compare to observations?
compareWithObservations = False
# list of region indices to plot from the region list in [regions] below
regionIndicesToPlot = [6]
# Number of points over which to compute moving average (e.g., for monthly
# output, movingAveragePoints=12 corresponds to a 12-month moving average
# window)
movingAveragePoints = 12
[timeSeriesSST]
## options related to plotting time series of sea surface temperature (SST)
## compare to output from another model run?
#compareWithModel = True
# compare to observations?
compareWithObservations = True
# list of region indices to plot from the region list in [regions] below
regionIndicesToPlot = [6]
# Number of points over which to compute moving average (e.g., for monthly
# output, movingAveragePoints=12 corresponds to a 12-month moving average
# window)
movingAveragePoints = 12
[timeSeriesNino34]
## options related to plotting time series of the El Nino 3.4 index
## compare to output from another model run?
#compareWithModel = True
# compare to observations?
compareWithObservations = True
# list of region indices to plot from the region list in [regions] below
regionIndicesToPlot = [6]
# Number of points over which to compute moving average (e.g., for monthly
# output, movingAveragePoints=12 corresponds to a 12-month moving average
# window)
movingAveragePoints = 12
[timeSeriesMHT]
## options related to plotting time series of meridional heat transport (MHT)
## compare to output from another model run?
#compareWithModel = True
# compare to observations?
compareWithObservations = True
# list of region indices to plot from the region list in [regions] below
regionIndicesToPlot = [6]
# Number of points over which to compute moving average (e.g., for monthly
# output, movingAveragePoints=12 corresponds to a 12-month moving average
# window)
movingAveragePoints = 12
[timeSeriesMOC]
## options related to plotting time series of meridional overturning
## circulation (MOC)
## compare to output from another model run?
#compareWithModel = True
# compare to observations?
compareWithObservations = True
# list of region indices to plot from the region list in [regions] below
regionIndicesToPlot = [6]
# Number of points over which to compute moving average (e.g., for monthly
# output, movingAveragePoints=12 corresponds to a 12-month moving average
# window)
movingAveragePoints = 12
[timeSeriesSeaIceAreaVol]
## options related to plotting time series of sea ice area and volume
## compare to output from another model run?
#compareWithModel = True
# compare to observations?
compareWithObservations = True
# list of region indices to plot from the region list in [regions] below
regionIndicesToPlot = [6]
# Number of points over which to compute moving average (e.g., for monthly
# output, movingAveragePoints=12 corresponds to a 12-month moving average
# window)
movingAveragePoints = 1
# title font properties
titleFontSize = 18
[regriddedSST]
## options related to plotting horizontally regridded sea surface temperature
## (SST) against reference model results and observations
# colormap for model/observations
resultColormap = RdYlBu_r
# indices into resultColormap for contour color
resultColormapIndices = [0, 40, 80, 110, 140, 170, 200, 230, 255]
# colormap levels/values for contour boundaries
resultContourValues = [-2, 0, 2, 6, 10, 16, 22, 26, 28, 32]
# colormap for differences
differenceColormap = coolwarm
# indices into differenceColormap for contour color
differenceColormapIndices = [0, 40, 80, 120, 140, 170, 210, 255]
# colormap levels/values for contour boundaries
differenceContourValues = [-5, -3, -2, -1, 0, 1, 2, 3, 5]
# alternative colormap/index suggestions
#resultColormap = viridis
#differenceColormap = RdBu_r
#differenceColormapIndices = [0, 40, 80, 127, 170, 210, 255]
#differenceContourValues = [-3, -2, -1, -0.5, 0.5, 1, 2, 3]
# Times for comparison times (Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec, JFM, AMJ, JAS, OND, ANN)
comparisonTimes = ['JFM', 'JAS', 'ANN']
[regriddedSSS]
## options related to plotting horizontally regridded sea surface salinity
## (SSS) against reference model results and observations
# colormap for model/observations
resultColormap = RdYlBu_r
# indices into resultColormap for contour color
resultColormapIndices = [0, 40, 80, 110, 140, 170, 200, 230, 255]
# colormap levels/values for contour boundaries
resultContourValues = [28, 29, 30, 31, 32, 33, 34, 35, 36, 38]
# colormap for differences
differenceColormap = coolwarm
# indices into differenceColormap for contour color
differenceColormapIndices = [0, 40, 80, 120, 140, 170, 210, 255]
# colormap levels/values for contour boundaries
differenceContourValues = [-3, -2, -1, -0.5, 0.5, 1, 2, 3]
# Times for comparison times (Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec, JFM, AMJ, JAS, OND, ANN)
comparisonTimes = ['JFM', 'JAS', 'ANN']
[regriddedMLD]
## options related to plotting horizontally regridded mixed layer depth
## (MLD) against reference model results and observations
# colormap for model/observations
resultColormap = viridis
# indices into resultColormap for contour color
resultColormapIndices = [0, 40, 80, 110, 140, 170, 200, 230, 255]
# colormap levels/values for contour boundaries
resultContourValues = [0, 20, 40, 60, 80, 100, 150, 200, 400, 800]
###### Xylar's note: I think something is off here. I think there should
###### be one more contour value than there are indices but there are 2 in MLD
# colormap for differences
differenceColormap = RdBu_r
# indices into differenceColormap for contour color
differenceColormapIndices = [0, 40, 80, 120, 140, 170, 210, 255]
# colormap levels/values for contour boundaries
differenceContourValues = [-175, -125, -75, -25, -10, 10, 25, 75, 125, 175]
# Times for comparison times (Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec, JFM, AMJ, JAS, OND, ANN)
comparisonTimes = ['JFM', 'JAS', 'ANN']
[regriddedSeaIceConcThick]
## options related to plotting horizontally regridded sea ice concentration
## and thickness against reference model results and observations
# colormap for model/observations
resultColormap = inferno
# indices into resultColormap for contour color
resultColormapIndices = [20, 80, 110, 140, 170, 200, 230, 255]
# colormap levels/values for contour boundaries for:
# concentration in winter and summer
resultConcWinterContourValues = [0.15, 0.4, 0.7, 0.9, 0.94, 0.96, 0.98, 0.99, 1]
resultConcSummerContourValues = [0.15, 0.3, 0.5, 0.7, 0.8, 0.85, 0.9, 0.95, 1]
# thickness in the northern and southern hemispheres
resultThickNHContourValues = [0, 0.25, 0.5, 1, 1.5, 2, 2.5, 3, 3.5]
resultThickSHContourValues = [0, 0.2, 0.4, 0.6, 0.8, 1, 1.5, 2, 2.5]
# colormap for differences
differenceColormap = RdBu_r
# indices into differenceColormap for contour color
differenceColormapIndices = [0, 40, 80, 127, 127, 170, 210, 255]
# colormap levels/values for contour boundaries for:
# concentration in winter and summer
differenceConcWinterContourValues = [-0.8, -0.6, -0.4, -0.2, 0, 0.2, 0.4, 0.6, 0.8]
differenceConcSummerContourValues = [-0.8, -0.6, -0.4, -0.2, 0, 0.2, 0.4, 0.6, 0.8]
# thickness in the northern and southern hemispheres
differenceThickNHContourValues = [-2.5, -2, -0.5, -0.1, 0, 0.1, 0.5, 2, 2.5]
differenceThickSHContourValues = [-2.5, -2, -0.5, -0.1, 0, 0.1, 0.5, 2, 2.5]
# reference lat/lon for sea ice plots in the northern hemisphere
minimumLatitudeNH = 50
referenceLongitudeNH = 0
# reference lat/lon for sea ice plots in the southern hemisphere
minimumLatitudeSH = -50
referenceLongitudeSH = 180
[regions]
## options related to ocean regions used in several analysis modules
# list of region names (needs to be in the same order as region indices in
# time-series stats)
regions = ['arctic', 'equatorial', 'so', 'nino3', 'nino4', 'nino3.4', 'global']
# list of plot titles (needs to be in the same order as region indices in
# time-series stats)
plotTitles = ['Arctic', 'Equatorial (15S-15N)', 'Southern Ocean', 'Nino 3', 'Nino 4', 'Nino 3.4', 'Global Ocean']
[plot]
## options related to plotting that are the defaults across all analysis modules
# set to true if you want plots to be displayed (one by one) to the screen in
# addition to being written out to png files
# Note: displayToScreen = True seems to hang on Edison on large data sets,
# so suggested use is just for debugging either locally or with small data sets
displayToScreen = False
# font size on axes
axisFontSize = 16
# title font properties
titleFontSize = 20
titleFontColor = black
titleFontWeight = normal