Create ldf_variable_defaults.yaml

Author: justin-richling

ldf_variable_defaults.yaml

@@ -0,0 +1,342 @@
+
+#This file lists out variable-specific defaults
+#for plotting and observations.  These defaults
+#are:
+#
+# PLOTTING:
+#
+# colormap             -> The colormap that will be used for filled contour plots.
+# contour_levels       -> A list of the specific contour values that will be used for contour plots.
+#                         Cannot be used with "contour_levels_range".
+# contour_levels_range -> The contour range that will be used for plots.
+#                         Values are min, max, and stride.  Cannot be used with "contour_levels".
+# diff_colormap        -> The colormap that will be used for filled contour different plots
+# diff_contour_levels  -> A list of the specific contour values thta will be used for difference plots.
+#                         Cannot be used with "diff_contour_range".
+# diff_contour_range   -> The contour range that will be used for difference plots.
+#                         Values are min, max, and stride. Cannot be used with "diff_contour_levels".
+# scale_factor         -> Amount to scale the variable (relative to its "raw" model values).
+# add_offset           -> Amount of offset to add to the variable (relatie to its "raw" model values).
+# new_unit             -> Variable units (if not using the  "raw" model units).
+# mpl                  -> Dictionary that contains keyword arguments explicitly for matplotlib
+#
+# mask                 -> Setting that specifies whether the variable should be masked.
+#                         Currently only accepts "landmask", which means the variable will be masked
+#                         everywhere that isn't land.
+#
+#
+# OBSERVATIONS:
+#
+# obs_file     -> Path to observations file.  If only the file name is given, then the file is assumed to
+#                 exist in the path specified by "obs_data_loc" in the config file.
+# obs_name     -> Name of the observational dataset (mostly used for plotting and generated file naming).
+#                 If this isn't present then the obs_file name is used.
+# obs_var_name -> Variable in the observations file to compare against.  If this isn't present then the
+#                 variable name is assumed to be the same as the model variable name.
+#
+#
+#
+# WEBSITE:
+#
+# category  -> The website category the variable will be placed under.
+#
+#
+# DERIVING:
+#
+# derivable_from -> If not present in the available output files, the variable can be derived from
+#                   other variables that are present (e.g. PRECT can be derived from PRECC and PRECL),
+#                   which are specified in this list
+#                   NOTE: this is not very flexible at the moment! It can only handle variables that
+#                         are sums of the constituents. Futher flexibility is being explored.
+#
+#
+# Final Note:  Please do not modify this file unless you plan to push your changes back to the ADF repo.
+#              If you would like to modify this file for your personal ADF runs then it is recommended
+#              to make a copy of this file, make modifications in that copy, and then point the ADF to
+#              it using the "defaults_file" config variable.
+#
+#+++++++++++
+
+#+++++++++++++
+# Available Land Default Plot Types
+#+++++++++++++
+default_ptypes: ["Tables","LatLon","TimeSeries",
+                  "Arctic","RegionalClimo","RegionalTimeSeries","Special"]
+
+#+++++++++++++
+# Constants
+#+++++++++++++
+
+#seconds per day :
+spd: 86400 
+diff_levs: [-100,-75,-50,-40,-30,-20,-10,-8,-6,-4,-2,0,2,4,6,8,10,20,30,40,50,75,100]
+
+#+++++++++++++
+# Category: Atmosphere
+#+++++++++++++
+
+TSA:    # 2m air temperature  
+  category: "Atmosphere"
+  colormap: "coolwarm"
+  contour_levels_range: [250, 310, 10]
+
+PREC:   # RAIN + SNOW
+  category: "Atmosphere"
+  colormap: "managua"
+  derivable_from: ["RAIN","SNOW"]
+  scale_factor: 86400
+  add_offset: 0
+  new_unit: "mm d$^{-1}$"
+  mpl:
+    colorbar:
+      label : "mm d$^{-1}$"
+  diff_colormap: "BrBG"
+  pct_diff_contour_levels: [-100,-75,-50,-40,-30,-20,-10,-8,-6,-4,-2,0,2,4,6,8,10,20,30,40,50,75,100]
+  pct_diff_colormap: "PuOr_r"
+
+FLDS: # atmospheric longwave radiation
+  category: "Atmosphere"
+  colormap: "Oranges"
+  contour_levels_range: [100, 500, 25]
+  diff_colormap: "BrBG"
+  diff_contour_range: [-20, 20, 2]
+  scale_factor: 1
+  add_offset: 0
+  new_unit: "Wm$^{-2}$"
+  mpl:
+    colorbar:
+      label : "Wm$^{-2}$"
+  pct_diff_contour_levels: [-100,-75,-50,-40,-30,-20,-10,-8,-6,-4,-2,0,2,4,6,8,10,20,30,40,50,75,100]
+  pct_diff_colormap: "PuOr_r"
+
+FSDS: # atmospheric incident solar radiation
+  category: "Atmosphere"
+  pct_diff_contour_levels: [-100,-75,-50,-40,-30,-20,-10,-8,-6,-4,-2,0,2,4,6,8,10,20,30,40,50,75,100]
+  pct_diff_colormap: "PuOr_r"
+
+WIND: # atmospheric air temperature
+  category: "Atmosphere"
+
+QBOT: # atmospheric specific humidity
+  category: "Atmosphere"
+
+TBOT:
+  category: "Atmosphere"
+  colormap: "coolwarm"
+  contour_levels_range: [250, 310, 10]
+
+TREFMNAV: # daily minimum of average 2m temperature
+  category: "Atmosphere"
+  colormap: "coolwarm"
+  contour_levels_range: [250, 310, 10]
+
+
+TREFMXAV: # daily maximum of average 2m temperature
+  category: "Atmosphere"
+  colormap: "cool warm"
+  contour_levels_range: [250, 310, 10]
+
+
+#+++++++++++
+# Category: Surface fluxes
+#+++++++++++
+
+ASA: # all-sky albedo:FSR/FSDS  
+  category: "Surface fluxes"
+  colormap: "RdBu_r"
+  diff_colormap: "BrBG"
+  derivable_from: ["FSR", "FSDS"]
+  pct_diff_contour_levels: [-100,-75,-50,-40,-30,-20,-10,-8,-6,-4,-2,0,2,4,6,8,10,20,30,40,50,75,100]
+  pct_diff_colormap: "PuOr_r"
+
+FSA: # absorbed solar radiation    
+  category: "Surface fluxes"
+
+FSH: # sensible heat  
+  category: "Surface fluxes"
+
+
+ET: # latent heat: FCTR+FCEV+FGEV
+  category: "Surface fluxes"
+  derivable_from: ["FCTR","FCEV","FGEV"]
+  colormap: "Blues"
+  contour_levels_range: [0, 220, 10]
+  diff_colormap: "BrBG"
+  diff_contour_range: [-45, 45, 5]
+  scale_factor: 1
+  add_offset: 0
+  new_unit: "Wm$^{-2}$"
+  mpl:
+    colorbar:
+      label : "Wm$^{-2}$"
+  pct_diff_contour_levels: [-100,-75,-50,-40,-30,-20,-10,-8,-6,-4,-2,0,2,4,6,8,10,20,30,40,50,75,100]
+  pct_diff_colormap: "PuOr_r"
+
+DSTFLXT: # total surface dust emission
+  category: "Surface fluxes"
+  colormap: "Browns"
+  diff_colormap: "BrBG_r"
+  scale_factor: 86400
+  add_offset: 0
+  new_unit: "kg m$^{-2}$ d$^{-1}"
+  mpl:
+    colorbar:
+      label : "kg m$^{-2}$ d$^{-1}"
+  pct_diff_contour_levels: [-100,-75,-50,-40,-30,-20,-10,-8,-6,-4,-2,0,2,4,6,8,10,20,30,40,50,75,100]
+  pct_diff_colormap: "PuOr_r"
+  scale_factor_table: 0.000365  #days to years, kg/m2 to Pg globally
+  avg_method: 'sum'
+  table_unit: "Pg y$^{-1}"
+
+MEG_isoprene: # total surface dust emission
+  category: "Surface fluxes"
+  colormap: "Browns"
+  diff_colormap: "BrBG_r"
+  scale_factor: 86400
+  add_offset: 0
+  new_unit: "kg m$^{-2}$ d$^{-1}"
+  mpl:
+    colorbar:
+      label : "kg m$^{-2}$ d$^{-1}"
+  pct_diff_contour_levels: [-100,-75,-50,-40,-30,-20,-10,-8,-6,-4,-2,0,2,4,6,8,10,20,30,40,50,75,100]
+  pct_diff_colormap: "PuOr_r"
+  scale_factor_table: 0.365  #days to years, kg/m2 to Tg globally
+  avg_method: 'sum'
+  table_unit: "Tg y$^{-1}"
+
+
+#+++++++++++
+# Category: Hydrology
+#+++++++++++
+FSNO: # fraction of ground covered by snow    
+  category: "Hydrology"
+
+
+H2OSNO: # SNOWICE + SNOWLIQ
+  category: "Hydrology"
+
+
+SNOWDP: # snow height
+  category: "Hydrology"
+
+
+TOTRUNOFF: # total liquid runoff
+  category: "Hydrology"
+  derivable_from: ["QOVER","QDRAI","QRGWL"] #TODO, check accuracy
+  colormap: "Blues"
+  scale_factor: 86400
+  add_offset: 0
+  new_unit: "mm d$^{-1}$"
+  mpl:
+    colorbar:
+      label : "mm d$^{-1}$"
+  
+#+++++++++++
+# Category: Vegetation
+#+++++++++++
+BTRANMN: # Transpiration beta factor
+  category: "Vegetation" # Or hydrology?
+
+ELAI: # exposed one-sided leaf area index
+  category: "Vegetation"
+  colormap: "gist_earth_r"
+  contour_levels_range: [0., 7., 1.0]
+  diff_colormap: "PuOr_r"
+  diff_contour_range: [-3.,3.,0.5]
+
+
+HTOP: # canopy top height
+  category: "Vegetation"
+
+
+TSAI: # total one-sided stem area index
+  category: "Vegetation"
+
+
+#+++++++++++
+# Category: Carbon
+#+++++++++++
+GPP: # Gross Primary Production
+  category: "Carbon"
+  colormap: "gist_earth_r"
+  contour_levels_range: [0., 8., 0.5]
+  diff_colormap: "BrBG"
+  diff_contour_range: [-4.,4.,0.5]
+  scale_factor: 86400
+  add_offset: 0
+  new_unit: "gC m$^{-2} d$^{-1}"
+  mpl:
+    colorbar:  #TODO make this print correctly
+      label : "gC ${m^-2 d^-1}"
+  pct_diff_contour_levels: [-100,-75,-50,-40,-30,-20,-10,-8,-6,-4,-2,0,2,4,6,8,10,20,30,40,50,75,100]
+  pct_diff_colormap: "PuOr_r"
+  scale_factor_table: 0.000000365  #days to years, g/m2 to Pg globally
+  avg_method: 'sum'
+  table_unit: "PgC y$^{-1}"
+
+AR: # Autotrophic Respiration
+  category: "Carbon"
+  colormap: "gist_earth_r"
+  contour_levels_range: [0., 3., 0.25]
+  diff_colormap: "BrBG"
+  diff_contour_range: [-1.5, 1.5, 0.25]
+  scale_factor: 86400
+  add_offset: 0
+  new_unit: "gC m$^{-2} d$^{-1}"
+  mpl:
+    colorbar:
+      label : "gC m$^{-2} d$^{-1}"
+  pct_diff_contour_levels: [-100,-75,-50,-40,-30,-20,-10,-8,-6,-4,-2,0,2,4,6,8,10,20,30,40,50,75,100]
+  pct_diff_colormap: "PuOr_r"
+  scale_factor_table: 0.000000365  #days to years, g/m2 to Pg globally
+  avg_method: 'sum'
+  table_unit: "PgC y$^{-1}"
+
+NPP: # Net Primary Production
+  category: "Carbon"
+  colormap: "gist_earth_r"
+  contour_levels_range: [0., 3., 0.25]
+  diff_colormap: "PuOr_r"
+  diff_contour_range: [-1.5, 1.5, 0.25]
+  scale_factor: 86400
+  add_offset: 0
+  new_unit: "gC m$^{-2} d$^{-1}"
+  mpl:
+    colorbar:
+      label : "gC m$^{-2} d$^{-1}"
+  pct_diff_contour_levels: [-100,-75,-50,-40,-30,-20,-10,-8,-6,-4,-2,0,2,4,6,8,10,20,30,40,50,75,100]
+  pct_diff_colormap: "PuOr_r"
+  scale_factor_table: 0.000000365  #days to years, g/m2 to Pg globally
+  avg_method: 'sum'
+  table_unit: "PgC y$^{-1}"
+
+TOTECOSYSC_1m:
+  category: "Carbon"
+  scale_factor_table: 0.000000001  #g/m2 to Pg globally
+  avg_method: 'sum'
+  table_unit: "PgC"
+
+TOTSOMC_1m:
+  category: "Carbon"
+
+
+TOTVEGC:
+  category: "Carbon"
+
+
+#+++++++++++
+# Category: Soils
+#+++++++++++
+ALTMAX: # Active Layer Thickness   
+  category: "Soils"
+
+
+SOILWATER_10CM: # soil liquid water + ice in top 10cm of soil
+  category: "Soils" # or hydrology?
+
+TSOI_10CM: # Soil temperature, 0-10 cm   
+  category: "Soils"
+
+
+
+#End of File