-
Notifications
You must be signed in to change notification settings - Fork 2
/
config_amwg_default_plots.yaml
470 lines (392 loc) · 17.2 KB
/
config_amwg_default_plots.yaml
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
#==============================
# config_amwg_default_plots.yaml
# This config file contains the standard set of variables and plots used for
# evaluating CAM simulations in the AMWG working group.
#Currently, if one is on NCAR's Casper or
#Cheyenne machine, then only the diagnostic output
#paths are needed, at least to perform a quick test
#run (these are indicated with "MUST EDIT" comments).
#Running these diagnostics on a different machine,
#or with a different, non-example simulation, will
#require additional modifications.
#
#Config file Keywords:
#--------------------
#
#1. Using ${xxx} will substitute that text with the
# variable referenced by xxx. For example:
#
# cam_case_name: cool_run
# cam_climo_loc: /some/where/${cam_case_name}
#
# will set "cam_climo_loc" in the diagnostics package to:
# /some/where/cool_run
#
# Please note that currently this will only work if the
# variable only exists in one location in the file.
#
#2. Using ${<top_level_section>.xxx} will do the same as
# keyword 1 above, but specifies which sub-section the
# variable is coming from, which is necessary for variables
# that are repeated in different subsections. For example:
#
# diag_basic_info:
# cam_climo_loc: /some/where/${diag_cam_climo.start_year}
#
# diag_cam_climo:
# start_year: 1850
#
# will set "cam_climo_loc" in the diagnostics package to:
# /some/where/1850
#
#Finally, please note that for both 1 and 2 the keywords must be lowercase.
#This is because future developments will hopefully use other keywords
#that are uppercase. Also please avoid using periods (".") in variable
#names, as this will likely cause issues with the current file parsing
#system.
#--------------------
#
##==============================
#
# This file doesn't (yet) read environment variables, so the user must
# set this themselves. It is also a good idea to search the doc for 'user'
# to see what default paths are being set for output/working files.
#
# Note that the string 'USER-NAME-NOT-SET' is used in the jupyter script
# to check for a failure to customize
#
user: 'USER-NAME-NOT-SET'
#This first set of variables specify basic info used by all diagnostic runs:
diag_basic_info:
#Is this a model vs observations comparison?
#If "false" or missing, then a model-model comparison is assumed:
compare_obs: false
#Generate HTML website (assumed false if missing):
#Note: The website files themselves will be located in the path
#specified by "cam_diag_plot_loc", under the "<diag_run>/website" subdirectory,
#where "<diag_run>" is the subdirectory created for this particular diagnostics run
#(usually "case_vs_obs_XXX" or "case_vs_baseline_XXX").
create_html: true
#Location of observational datasets:
#Note: this only matters if "compare_obs" is true and the path
#isn't specified in the variable defaults file.
obs_data_loc: /glade/campaign/cgd/amp/amwg/ADF_obs
#Location where re-gridded and interpolated CAM climatology files are stored:
cam_regrid_loc: /glade/derecho/scratch/${user}/ADF/regrid
#Overwrite CAM re-gridded files?
#If false, or missing, then regridding will be skipped for regridded variables
#that already exist in "cam_regrid_loc":
cam_overwrite_regrid: false
#Location where diagnostic plots are stored:
cam_diag_plot_loc: /glade/derecho/scratch/${user}/ADF/plots
#Location of ADF variable plotting defaults YAML file:
#If left blank or missing, ADF/lib/adf_variable_defaults.yaml will be used
#Uncomment and change path for custom variable defaults file
#defaults_file: /some/path/to/defaults/file.yaml
#Vertical pressure levels (in hPa) on which to plot 3-D variables
#when using horizontal (e.g. lat/lon) map projections.
#If this config option is missing, then no 3-D variables will be plotted on
#horizontal maps. Please note too that pressure levels must currently match
#what is available in the observations file in order to be plotted in a
#model vs obs run:
plot_press_levels: [200,850]
#Longitude line on which to center all lat/lon maps.
#If this config option is missing then the central
#longitude will default to 180 degrees E.
central_longitude: 180
#Number of processors on which to run the ADF.
#If this config variable isn't present then
#the ADF defaults to one processor. Also, if
#you set it to "*" then it will default
#to all of the processors available on a
#single node/machine:
num_procs: 8
#If set to true, then redo all plots even if they already exist.
#If set to false, then if a plot is found it will be skipped:
redo_plot: false
#This second set of variables provides info for the CAM simulation(s) being diagnosed:
diag_cam_climo:
# History file list of strings to match
# eg. cam.h0 or ocn.pop.h.ecosys.nday1 or hist_str: [cam.h2,cam.h0]
# Only affects timeseries as everything else uses the created timeseries
# Default:
hist_str: cam.h0
#Calculate climatologies?
#If false, the climatology files will not be created:
calc_cam_climo: true
#Overwrite CAM climatology files?
#If false, or not prsent, then already existing climatology files will be skipped:
cam_overwrite_climo: false
#Name of CAM case (or CAM run name):
cam_case_name: b.e23_alpha17f.BLT1850.ne30_t232.098
#Case nickname
#NOTE: if nickname starts with '0' - nickname must be in quotes!
# ie '026a' as opposed to 026a
#If missing or left blank, will default to cam_case_name
case_nickname: #cool nickname
#Location of CAM history (h0) files:
#Example test files
cam_hist_loc: /glade/campaign/cgd/amp/amwg/ADF_test_cases/${diag_cam_climo.cam_case_name}
#Location of CAM climatologies (to be created and then used by this script)
cam_climo_loc: /glade/derecho/scratch/${user}/ADF/${diag_cam_climo.cam_case_name}/climo
#model year when time series files should start:
#Note: Leaving this entry blank will make time series
# start at earliest available year.
start_year: 10
#model year when time series files should end:
#Note: Leaving this entry blank will make time series
# end at latest available year.
end_year: 14
#Do time series files exist?
#If True, then diagnostics assumes that model files are already time series.
#If False, or if simply not present, then diagnostics will attempt to create
#time series files from history (time-slice) files:
cam_ts_done: false
#Save interim time series files?
#WARNING: This can take up a significant amount of space,
# but will save processing time the next time
cam_ts_save: true
#Overwrite time series files, if found?
#If set to false, then time series creation will be skipped if files are found:
cam_overwrite_ts: false
#Location where time series files are (or will be) stored:
cam_ts_loc: /glade/derecho/scratch/${user}/ADF/${diag_cam_climo.cam_case_name}/ts
#TEM diagnostics
#---------------
#TEM history file number
#If missing or blank, ADF will default to h4
tem_hist_str: cam.h4
#Location where TEM files are stored:
#NOTE: If path not specified or commented out, TEM calculation/plots will be skipped!
cam_tem_loc: /glade/derecho/scratch/${user}/${diag_cam_climo.cam_case_name}/tem/
#Overwrite TEM files, if found?
#If set to false, then TEM creation will be skipped if files are found:
overwrite_tem: false
#----------------------
#This third set of variables provide info for the CAM baseline climatologies.
#This only matters if "compare_obs" is false:
diag_cam_baseline_climo:
# History file list of strings to match
# eg. cam.h0 or ocn.pop.h.ecosys.nday1 or hist_str: [cam.h2,cam.h0]
# Only affects timeseries as everything else uses the created timeseries
# Default:
hist_str: cam.h0
#Calculate cam baseline climatologies?
#If false, the climatology files will not be created:
calc_cam_climo: true
#Overwrite CAM climatology files?
#If false, or not present, then already existing climatology files will be skipped:
cam_overwrite_climo: false
#Name of CAM baseline case:
cam_case_name: b.e23_alpha17f.BLT1850.ne30_t232.093
#Baseline case nickname
#NOTE: if nickname starts with '0' - nickname must be in quotes!
# ie '026a' as opposed to 026a
#If missing or left blank, will default to cam_case_name
case_nickname: #cool nickname
#Location of CAM baseline history (h0) files:
#Example test files
cam_hist_loc: /glade/campaign/cgd/amp/amwg/ADF_test_cases/${diag_cam_baseline_climo.cam_case_name}
#Location of baseline CAM climatologies:
cam_climo_loc: /glade/derecho/scratch/${user}/ADF/${diag_cam_baseline_climo.cam_case_name}/climo
#model year when time series files should start:
#Note: Leaving this entry blank will make time series
# start at earliest available year.
start_year: 10
#model year when time series files should end:
#Note: Leaving this entry blank will make time series
# end at latest available year.
end_year: 14
#Do time series files need to be generated?
#If True, then diagnostics assumes that model files are already time series.
#If False, or if simply not present, then diagnostics will attempt to create
#time series files from history (time-slice) files:
cam_ts_done: false
#Save interim time series files for baseline run?
#WARNING: This can take up a significant amount of space:
cam_ts_save: true
#Overwrite baseline time series files, if found?
#If set to false, then time series creation will be skipped if files are found:
cam_overwrite_ts: false
#Location where time series files are (or will be) stored:
cam_ts_loc: /glade/derecho/scratch/${user}/ADF/${diag_cam_baseline_climo.cam_case_name}/ts
#TEM diagnostics
#---------------
#TEM history file number
#If missing or blank, ADF will default to h4
tem_hist_str: cam.h4
#Location where TEM files are stored:
#NOTE: If path not specified or commented out, TEM calculation/plots will be skipped!
cam_tem_loc: /glade/derecho/scratch/${user}/${diag_cam_baseline_climo.cam_case_name}/tem/
#Overwrite TEM files, if found?
#If set to false, then TEM creation will be skipped if files are found:
overwrite_tem: false
#This fourth set of variables provides settings for calling the Climate Variability
# Diagnostics Package (CVDP). If cvdp_run is set to true the CVDP will be set up and
# run in background mode, likely completing after the ADF has completed.
# If CVDP is to be run PSL, TREFHT, TS and PRECT (or PRECC and PRECL) should be listed
# in the diag_var_list variable listing.
# For more CVDP information: https://www.cesm.ucar.edu/working_groups/CVC/cvdp/
diag_cvdp_info:
# Run the CVDP on the listed run(s)?
cvdp_run: false
# CVDP code path, sets the location of the CVDP codebase
# CGD systems path = /home/asphilli/CESM-diagnostics/CVDP/Release/v5.2.0/
# CISL systems path = /glade/u/home/asphilli/CESM-diagnostics/CVDP/Release/v5.2.0/
# github location = https://github.com/NCAR/CVDP-ncl
cvdp_codebase_loc: /glade/u/home/asphilli/CESM-diagnostics/CVDP/Release/v5.2.0/
# Location where cvdp codebase will be copied to and diagnostic plots will be stored
cvdp_loc: /glade/derecho/scratch/${user}/ADF/cvdp/
# tar up CVDP results?
cvdp_tar: false
# This set of variables provides settings for calling NOAA's
# Model Diagnostic Task Force (MDTF) diagnostic package.
# https://github.com/NOAA-GFDL/MDTF-diagnostics
#
# If mdtf_run: true, the MDTF will be set up and
# run in background mode, likely completing after the ADF has completed.
#
# WARNING: This currently only runs on CASPER (not derecho)
#
# The variables required depend on the diagnostics (PODs) selected.
# AMWG-developed PODS and their required variables:
# (Note that PRECT can be computed from PRECC & PRECL)
# - MJO_suite: daily PRECT, FLUT, U850, U200, V200 (all required)
# - Wheeler-Kiladis Wavenumber Frequency Spectra: daily PRECT, FLUT, U200, U850, OMEGA500
# (will use what is available)
# - Blocking (Rich Neale): daily OMEGA500
# - Precip Diurnal Cycle (Rich Neale): 3-hrly PRECT
#
# Many other diagnostics are available; see
# https://mdtf-diagnostics.readthedocs.io/en/main/sphinx/start_overview.html
#
diag_mdtf_info:
# Run the MDTF on the model cases
mdtf_run: false
# The file that will be written by ADF to input to MDTF. Call this whatever you want.
mdtf_input_settings_filename : mdtf_input.json
## MDTF code path, sets the location of the MDTF codebase and pre-compiled conda envs
# CHANGE if you have any: your own MDTF code, installed conda envs and/or obs_data
mdtf_codebase_path : /glade/campaign/cgd/amp/amwg/mdtf
mdtf_codebase_loc : ${mdtf_codebase_path}/MDTF-diagnostics.v3.1.20230817.ADF
conda_root : /glade/u/apps/opt/conda
conda_env_root : ${mdtf_codebase_path}/miniconda2/envs.MDTFv3.1.20230412/
OBS_DATA_ROOT : ${mdtf_codebase_path}/obs_data
# SET this to a writable dir. The ADF will place ts files here for the MDTF to read (adds the casename)
MODEL_DATA_ROOT : ${diag_cam_climo.cam_ts_loc}/mdtf/inputdata/model
# Choose diagnostics (PODs). Full list of available PODs: https://github.com/NOAA-GFDL/MDTF-diagnostics
pod_list : [ "MJO_suite" ]
# Intermediate/output file settings
make_variab_tar: false # tar up MDTF results
save_ps : false # save postscript figures in addition to bitmaps
save_nc : true # save netCDF files of processed data (recommend true when starting with new model data)
overwrite: true # overwrite results in OUTPUT_DIR; otherwise results saved under a unique name
# Settings used in debugging:
verbose : 3 # Log verbosity level.
test_mode: false # Set to true for framework test. Data is fetched but PODs are not run.
dry_run : false # Framework test. No external commands are run and no remote data is copied. Implies test_mode.
# Settings that shouldn't change in ADF implementation for now
data_type : single_run # single_run or multi_run (only works with single right now)
data_manager : Local_File # Fetch data or it is local?
environment_manager : Conda # Manage dependencies
#+++++++++++++++++++++++++++++++++++++++++++++++++++
#These variables below only matter if you are using
#a non-standard method, or are adding your own
#diagnostic scripts.
#+++++++++++++++++++++++++++++++++++++++++++++++++++
#Note: If you want to pass arguments to a particular script, you can
#do it like so (using the "averaging_example" script in this case):
# - {create_climo_files: {kwargs: {clobber: true}}}
#Name of time-averaging scripts being used to generate climatologies.
#These scripts must be located in "scripts/averaging":
time_averaging_scripts:
- create_climo_files
#- create_TEM_files #To generate TEM files, please un-comment
#Name of regridding scripts being used.
#These scripts must be located in "scripts/regridding":
regridding_scripts:
- regrid_and_vert_interp
#List of analysis scripts being used.
#These scripts must be located in "scripts/analysis":
analysis_scripts:
- amwg_table
#- aerosol_gas_tables
#List of plotting scripts being used.
#These scripts must be located in "scripts/plotting":
plotting_scripts:
- global_latlon_map
- global_latlon_vect_map
- zonal_mean
- polar_map
- cam_taylor_diagram
- ozone_diagnostics
#- tape_recorder
#- tem
#- regional_map_multicase #To use this please un-comment and fill-out
#the "region_multicase" section below
#List of CAM variables that will be processesd:
#If CVDP is to be run PSL, TREFHT, TS and PRECT (or PRECC and PRECL) should be listed
diag_var_list:
- AODDUST
- AODVIS
- CLDHGH
- CLDICE
- CLDLIQ
- CLDLOW
- CLDMED
- CLDTOT
- CLOUD
- FLNS
- FLNT
- FLNTC
- FSNS
- FSNT
- FSNTC
- LHFLX
- LWCF
- OMEGA500
- PBLH
- PRECT
- PS
- PSL
- QFLX
- RELHUM
- SHFLX
- SST
- SWCF
- T
- TAUX
- TAUY
- TGCLDIWP
- TGCLDLWP
- TMQ
- TREFHT
- TS
- U
- U10
- ICEFRAC
- OCNFRAC
- LANDFRAC
- O3
#<Add more variables here.>
# MDTF recommended variables
# - OMEGA
# - PRECT
# - PS
# - PSL
# - U200
# - U850
# - V200
# - V850
# Options for multi-case regional contour plots (./plotting/regional_map_multicase.py)
# region_multicase:
# region_spec: [slat, nlat, wlon, elon]
# region_time_option: <calendar | zeroanchor> # If calendar, will look for specified years. If zeroanchor will use a nyears starting from year_offset from the beginning of timeseries
# region_start_year:
# region_end_year:
# region_nyear:
# region_year_offset:
# region_month: <NULL means look for season>
# region_season: <NULL means use annual mean>
# region_variables: <list of variables to try to use; allows for a subset of the total diag variables>
#END OF FILE