|
| 1 | +#============================== |
| 2 | +#config_cam_baseline_example.yaml |
| 3 | + |
| 4 | +#This is the main CAM diagnostics config file |
| 5 | +#for doing comparisons of a CAM run against |
| 6 | +#another CAM run, or a CAM baseline simulation. |
| 7 | + |
| 8 | +#Currently, if one is on NCAR's Casper or |
| 9 | +#Cheyenne machine, then only the diagnostic output |
| 10 | +#paths are needed, at least to perform a quick test |
| 11 | +#run (these are indicated with "MUST EDIT" comments). |
| 12 | +#Running these diagnostics on a different machine, |
| 13 | +#or with a different, non-example simulation, will |
| 14 | +#require additional modifications. |
| 15 | +# |
| 16 | +#Config file Keywords: |
| 17 | +#-------------------- |
| 18 | +# |
| 19 | +#1. Using ${xxx} will substitute that text with the |
| 20 | +# variable referenced by xxx. For example: |
| 21 | +# |
| 22 | +# cam_case_name: cool_run |
| 23 | +# cam_climo_loc: /some/where/${cam_case_name} |
| 24 | +# |
| 25 | +# will set "cam_climo_loc" in the diagnostics package to: |
| 26 | +# /some/where/cool_run |
| 27 | +# |
| 28 | +# Please note that currently this will only work if the |
| 29 | +# variable only exists in one location in the file. |
| 30 | +# |
| 31 | +#2. Using ${<top_level_section>.xxx} will do the same as |
| 32 | +# keyword 1 above, but specifies which sub-section the |
| 33 | +# variable is coming from, which is necessary for variables |
| 34 | +# that are repeated in different subsections. For example: |
| 35 | +# |
| 36 | +# diag_basic_info: |
| 37 | +# cam_climo_loc: /some/where/${diag_cam_climo.start_year} |
| 38 | +# |
| 39 | +# diag_cam_climo: |
| 40 | +# start_year: 1850 |
| 41 | +# |
| 42 | +# will set "cam_climo_loc" in the diagnostics package to: |
| 43 | +# /some/where/1850 |
| 44 | +# |
| 45 | +#Finally, please note that for both 1 and 2 the keywords must be lowercase. |
| 46 | +#This is because future developments will hopefully use other keywords |
| 47 | +#that are uppercase. Also please avoid using periods (".") in variable |
| 48 | +#names, as this will likely cause issues with the current file parsing |
| 49 | +#system. |
| 50 | +#-------------------- |
| 51 | +# |
| 52 | +##============================== |
| 53 | +# |
| 54 | +# This file doesn't (yet) read environment variables, so the user must |
| 55 | +# set this themselves. It is also a good idea to search the doc for 'user' |
| 56 | +# to see what default paths are being set for output/working files. |
| 57 | +# |
| 58 | +# Note that the string 'USER-NAME-NOT-SET' is used in the jupyter script |
| 59 | +# to check for a failure to customize |
| 60 | +# |
| 61 | +user: 'USER-NAME-NOT-SET' |
| 62 | + |
| 63 | +#This first set of variables specify basic info used by all diagnostic runs: |
| 64 | +diag_basic_info: |
| 65 | + |
| 66 | + #Does the user want plotting of unstructured (native) grid? |
| 67 | + #If "false" or missing, then the ADF expects ALL cases to be on lat/lon grids: |
| 68 | + unstructured_plotting: false |
| 69 | + |
| 70 | + #Is this a model vs observations comparison? |
| 71 | + #If "false" or missing, then a model-model comparison is assumed: |
| 72 | + compare_obs: false |
| 73 | + |
| 74 | + #Generate HTML website (assumed false if missing): |
| 75 | + #Note: The website files themselves will be located in the path |
| 76 | + #specified by "cam_diag_plot_loc", under the "<diag_run>/website" subdirectory, |
| 77 | + #where "<diag_run>" is the subdirectory created for this particular diagnostics run |
| 78 | + #(usually "case_vs_obs_XXX" or "case_vs_baseline_XXX"). |
| 79 | + create_html: true |
| 80 | + |
| 81 | + #Location of observational datasets: |
| 82 | + #Note: this only matters if "compare_obs" is true and the path |
| 83 | + #isn't specified in the variable defaults file. |
| 84 | + obs_data_loc: /glade/campaign/cgd/amp/amwg/ADF_obs |
| 85 | + |
| 86 | + #Location where re-gridded and interpolated CAM climatology files are stored: |
| 87 | + cam_regrid_loc: /glade/derecho/scratch/${user}/ADF/regrid |
| 88 | + |
| 89 | + #Overwrite CAM re-gridded files? |
| 90 | + #If false, or missing, then regridding will be skipped for regridded variables |
| 91 | + #that already exist in "cam_regrid_loc": |
| 92 | + cam_overwrite_regrid: false |
| 93 | + |
| 94 | + #Location where diagnostic plots are stored: |
| 95 | + cam_diag_plot_loc: /glade/derecho/scratch/${user}/ADF/plots |
| 96 | + |
| 97 | + #Location of ADF variable plotting defaults YAML file: |
| 98 | + #If left blank or missing, ADF/lib/adf_variable_defaults.yaml will be used |
| 99 | + #Uncomment and change path for custom variable defaults file |
| 100 | + defaults_file: ldf_variable_defaults.yaml |
| 101 | + |
| 102 | + #Longitude line on which to center all lat/lon maps. |
| 103 | + #If this config option is missing then the central |
| 104 | + #longitude will default to 180 degrees E. |
| 105 | + central_longitude: 180 |
| 106 | + |
| 107 | + #Number of processors on which to run the ADF. |
| 108 | + #If this config variable isn't present then |
| 109 | + #the ADF defaults to one processor. Also, if |
| 110 | + #you set it to "*" then it will default |
| 111 | + #to all of the processors available on a |
| 112 | + #single node/machine: |
| 113 | + num_procs: 8 |
| 114 | + |
| 115 | + #If set to true, then redo all plots even if they already exist. |
| 116 | + #If set to false, then if a plot is found it will be skipped: |
| 117 | + redo_plot: true |
| 118 | + |
| 119 | +#This second set of variables provides info for the CAM simulation(s) being diagnosed: |
| 120 | +diag_cam_climo: |
| 121 | + |
| 122 | + # History file list of strings to match |
| 123 | + # eg. cam.h0 or ocn.pop.h.ecosys.nday1 or hist_str: [cam.h2,cam.h0] |
| 124 | + # Only affects timeseries as everything else uses the created timeseries |
| 125 | + # Default: |
| 126 | + hist_str: clm2.h0 |
| 127 | + |
| 128 | + #Calculate climatologies? |
| 129 | + #If false, the climatology files will not be created: |
| 130 | + calc_cam_climo: true |
| 131 | + |
| 132 | + #Overwrite CAM climatology files? |
| 133 | + #If false, or not prsent, then already existing climatology files will be skipped: |
| 134 | + cam_overwrite_climo: false |
| 135 | + |
| 136 | + #Location of CAM climatologies (to be created and then used by this script) |
| 137 | + cam_climo_loc: /glade/derecho/scratch/${user}/ADF/${diag_cam_climo.cam_case_name}/climo |
| 138 | + |
| 139 | + #Name of CAM case (or CAM run name): |
| 140 | + cam_case_name: b.e30_beta05.BLT1850.ne30_t232_wgx3.123 |
| 141 | + |
| 142 | + #Case nickname |
| 143 | + #NOTE: if nickname starts with '0' - nickname must be in quotes! |
| 144 | + # ie '026a' as opposed to 026a |
| 145 | + #If missing or left blank, will default to cam_case_name |
| 146 | + case_nickname: '123' |
| 147 | + |
| 148 | + #Location of CAM history (h0) files: |
| 149 | + cam_hist_loc: /glade/derecho/scratch/hannay/archive/${diag_cam_climo.cam_case_name}/lnd/hist/ |
| 150 | + |
| 151 | + # SE to FV regridding options |
| 152 | + # Leave these blank if not on the native grid |
| 153 | + #----------------------------- |
| 154 | + native_grid: true |
| 155 | + # Weights file: |
| 156 | + weights_file: /glade/work/wwieder/map_ne30pg3_to_fv0.9x1.25_scripgrids_conserve_nomask_c250108.nc |
| 157 | + # Regridding method: |
| 158 | + regrid_method: 'conservative' |
| 159 | + # Lat/lon file: |
| 160 | + latlon_file: /glade/derecho/scratch/wwieder/ctsm5.3.018_SP_f09_t232_mask/run/ctsm5.3.018_SP_f09_t232_mask.clm2.h0.0001-01.nc |
| 161 | + |
| 162 | + #model year when time series files should start: |
| 163 | + #Note: Leaving this entry blank will make time series |
| 164 | + # start at earliest available year. |
| 165 | + start_year: 25 |
| 166 | + |
| 167 | + #model year when time series files should end: |
| 168 | + #Note: Leaving this entry blank will make time series |
| 169 | + # end at latest available year. |
| 170 | + end_year: 35 |
| 171 | + |
| 172 | + #Do time series files exist? |
| 173 | + #If True, then diagnostics assumes that model files are already time series. |
| 174 | + #If False, or if simply not present, then diagnostics will attempt to create |
| 175 | + #time series files from history (time-slice) files: |
| 176 | + cam_ts_done: false |
| 177 | + |
| 178 | + #Save interim time series files? |
| 179 | + #WARNING: This can take up a significant amount of space, |
| 180 | + # but will save processing time the next time |
| 181 | + cam_ts_save: false |
| 182 | + |
| 183 | + #Overwrite time series files, if found? |
| 184 | + #If set to false, then time series creation will be skipped if files are found: |
| 185 | + cam_overwrite_ts: false |
| 186 | + |
| 187 | + #Location where time series files are (or will be) stored: |
| 188 | + cam_ts_loc: /glade/derecho/scratch/${user}/ADF/${diag_cam_climo.cam_case_name}/ts |
| 189 | + |
| 190 | + |
| 191 | +#This third set of variables provide info for the CAM baseline climatologies. |
| 192 | +#This only matters if "compare_obs" is false: |
| 193 | +diag_cam_baseline_climo: |
| 194 | + |
| 195 | + # History file list of strings to match |
| 196 | + # eg. cam.h0 or ocn.pop.h.ecosys.nday1 or hist_str: [cam.h2,cam.h0] |
| 197 | + # Only affects timeseries as everything else uses the created timeseries |
| 198 | + # Default: |
| 199 | + hist_str: clm2.h0 |
| 200 | + |
| 201 | + #Calculate cam baseline climatologies? |
| 202 | + #If false, the climatology files will not be created: |
| 203 | + calc_cam_climo: true |
| 204 | + |
| 205 | + #Overwrite CAM climatology files? |
| 206 | + #If false, or not present, then already existing climatology files will be skipped: |
| 207 | + cam_overwrite_climo: false |
| 208 | + |
| 209 | + #Location of CAM climatologies (to be created and then used by this script) |
| 210 | + cam_climo_loc: /glade/derecho/scratch/${user}/ADF/${diag_cam_baseline_climo.cam_case_name}/climo |
| 211 | + |
| 212 | + #Name of CAM baseline case: |
| 213 | + cam_case_name: b.e30_beta05.BLT1850.ne30_t232_wgx3.122 |
| 214 | + |
| 215 | + #Baseline case nickname |
| 216 | + #NOTE: if nickname starts with '0' - nickname must be in quotes! |
| 217 | + # ie '026a' as opposed to 026a |
| 218 | + #If missing or left blank, will default to cam_case_name |
| 219 | + case_nickname: '122' |
| 220 | + |
| 221 | + #Location of CAM baseline history (h0) files: |
| 222 | + #Example test files |
| 223 | + cam_hist_loc: /glade/derecho/scratch/hannay/archive/${diag_cam_baseline_climo.cam_case_name}/lnd/hist/ |
| 224 | + |
| 225 | + # SE to FV regridding options |
| 226 | + # Leave these blank if not on the native grid |
| 227 | + #----------------------------- |
| 228 | + native_grid: true |
| 229 | + # Weights file: |
| 230 | + weights_file: /glade/work/wwieder/map_ne30pg3_to_fv0.9x1.25_scripgrids_conserve_nomask_c250108.nc |
| 231 | + # Regridding method: |
| 232 | + regrid_method: 'conservative' |
| 233 | + # Lat/lon file: |
| 234 | + latlon_file: /glade/derecho/scratch/wwieder/ctsm5.3.018_SP_f09_t232_mask/run/ctsm5.3.018_SP_f09_t232_mask.clm2.h0.0001-01.nc |
| 235 | + |
| 236 | + #model year when time series files should start: |
| 237 | + #Note: Leaving this entry blank will make time series |
| 238 | + # start at earliest available year. |
| 239 | + start_year: 25 |
| 240 | + |
| 241 | + #model year when time series files should end: |
| 242 | + #Note: Leaving this entry blank will make time series |
| 243 | + # end at latest available year. |
| 244 | + end_year: 35 |
| 245 | + |
| 246 | + #Do time series files need to be generated? |
| 247 | + #If True, then diagnostics assumes that model files are already time series. |
| 248 | + #If False, or if simply not present, then diagnostics will attempt to create |
| 249 | + #time series files from history (time-slice) files: |
| 250 | + cam_ts_done: false |
| 251 | + |
| 252 | + #Save interim time series files for baseline run? |
| 253 | + #WARNING: This can take up a significant amount of space: |
| 254 | + cam_ts_save: true |
| 255 | + |
| 256 | + #Overwrite baseline time series files, if found? |
| 257 | + #If set to false, then time series creation will be skipped if files are found: |
| 258 | + cam_overwrite_ts: false |
| 259 | + |
| 260 | + #Location where time series files are (or will be) stored: |
| 261 | + cam_ts_loc: ${ts_loc}${diag_cam_baseline_climo.cam_case_name}/${diag_cam_baseline_climo.yrs}/ |
| 262 | + |
| 263 | + |
| 264 | +#+++++++++++++++++++++++++++++++++++++++++++++++++++ |
| 265 | +#These variables below only matter if you are using |
| 266 | +#a non-standard method, or are adding your own |
| 267 | +#diagnostic scripts. |
| 268 | +#+++++++++++++++++++++++++++++++++++++++++++++++++++ |
| 269 | + |
| 270 | +#Note: If you want to pass arguments to a particular script, you can |
| 271 | +#do it like so (using the "averaging_example" script in this case): |
| 272 | +# - {create_climo_files: {kwargs: {clobber: true}}} |
| 273 | + |
| 274 | +#Name of time-averaging scripts being used to generate climatologies. |
| 275 | +#These scripts must be located in "scripts/averaging": |
| 276 | +time_averaging_scripts: |
| 277 | + - create_climo_files |
| 278 | + |
| 279 | +#Name of regridding scripts being used. |
| 280 | +#These scripts must be located in "scripts/regridding": |
| 281 | +regridding_scripts: |
| 282 | + - regrid_and_vert_interp |
| 283 | + |
| 284 | +#List of analysis scripts being used. |
| 285 | +#These scripts must be located in "scripts/analysis": |
| 286 | +analysis_scripts: |
| 287 | + - lmwg_table |
| 288 | + |
| 289 | +#List of plotting scripts being used. |
| 290 | +#These scripts must be located in "scripts/plotting": |
| 291 | +plotting_scripts: |
| 292 | + - global_latlon_map |
| 293 | + - global_mean_timeseries_lnd |
| 294 | + - polar_map |
| 295 | + |
| 296 | +#List of CAM variables that will be processesd: |
| 297 | +#If CVDP is to be run PSL, TREFHT, TS and PRECT (or PRECC and PRECL) should be listed |
| 298 | +diag_var_list: |
| 299 | + #- TSA |
| 300 | + - PREC |
| 301 | + - ELAI |
| 302 | + - GPP |
| 303 | +# - NPP |
| 304 | +# - FSDS |
| 305 | +# - ALTMAX |
| 306 | + - ET |
| 307 | + - TOTRUNOFF |
| 308 | + - DSTFLXT |
| 309 | + - MEG_isoprene |
| 310 | + |
| 311 | +#END OF FILE |
0 commit comments