Skip to content

Commit 1d7f6a3

Browse files
committed
update YAML appendix with aircraft options
1 parent 2d43621 commit 1d7f6a3

File tree

1 file changed

+72
-3
lines changed

1 file changed

+72
-3
lines changed

docs/appendix/yaml.rst

+72-3
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@ where domain_type is equal to domain_name.
364364
(e.g., ['R1','R2','R3','R4','R5','R6','R7','R8','R9','R10']
365365

366366
**urban_rural_name:** list of only one string input, which is variable used to
367-
determine wheter urban or rural site. (e.g., ['msa_name'])
367+
determine whether urban or rural site. (e.g., ['msa_name'])
368368

369369
**urban_rural_differentiate_value:** string of value used to determine whether
370370
variable is rural or urban. (e.g., '').
@@ -381,7 +381,57 @@ for csi plot, list of model names (only) user choose to set as labels.
381381

382382
**score_name:** csi plot only. list of scores user can choose to plot. examples are "Critical Success Index' 'False Alarm Rate' 'Hit Rate'.
383383

384-
**threshold_tick_style:** csi plot only. (optional) control for spacing of threshold (x-axis) ticks. example: use ``nonlinear`` when nonlinear xticks including all thresholds are desired. Any other selection (default = None) will choose xticks that are equally spaced between min(threshold_list):max(threshold_list) and likely won't include all thresholds.
384+
**threshold_tick_style:** csi plot only. (optional) control for spacing of threshold (x-axis) ticks. example: use ``nonlinear`` when nonlinear xticks including all thresholds are desired. Any other selection (default = None) will choose xticks that are equally spaced between min(threshold_list):max(threshold_list) and likely won't include all thresholds.
385+
386+
**altitude_variable:** For "vert_profile" plot only. Name of altitude variable in observational
387+
dataset (e.g., altitude)
388+
389+
**vertprofile_bins:** For "vert_profile" plot only. List of vertical bins, on which to analyze the data.
390+
Units should be identical to the units of the altitude_variable specified above (e.g.,
391+
[0, 500, 1000, 1500, 2000, 2500, 3000, 3500, 4000] if altitude is in meters)
392+
393+
**color_map:** For 'scatter_density' plot only. Specify a default colormap in Matplotlib (e.g., 'RdBu_r').
394+
To use a custom colormap, leave color_map blank and provide the following options:
395+
396+
* **colors:** Specify a list of colors (e.g., ['royalblue', 'cyan', 'yellow', 'orange']).
397+
* **over:** Specify the color for data greater than the color bar (e.g., 'red')
398+
* **under:** Specify the color for data less than the color bar (e.g., 'blue')
399+
400+
**fill:** For 'scatter_density' plot only. Set to True if you want to to create a KDE plot
401+
(i.e., fill the area under the density curve) and set to False to create a scatter plot.
402+
403+
**shade_lowest:** For 'scatter_density' plot and if fill is set to True above (i.e., for KDE
404+
plots only.) Set to True if you want to shade the lowest contour.
405+
406+
**vcenter:** For 'scatter_density' plot only. Optionally, provide the central value for TwoSlopeNorm.
407+
408+
**color_map_custom:** For 'curtain' plot only. Set to True, to use a custom Matplotlib colormap and
409+
specify “colors” and "color_levels". To use a standard Matplotlib colormap, set to False and specify
410+
a “color_map”.
411+
412+
**colors:** For 'curtain' plot only. Used only if "color_map_custom" is set to True. Provide
413+
a list of colors (e.g., ["#ff8cff", "#dd6ff2", "#bb52e5", "#9935d8", "#7718cb", "#0000bb", "#002ccc",
414+
"#0058dd", "#0084ee", "#00afff", "#00ebff", "#27ffd7", "#63ff9b", "#a3ff5b", "#d3ff2b", "#ffff00",
415+
"#ffcf00", "#ff9f00", "#ff6f00", "#ff3f00", "#ff0000", "#d8000f", "#b2001f", "#8c002f", "#66003f",
416+
"#343434", "#606060", "#8c8c8c", "#b8b8b8", "#e4e4e4"]).
417+
418+
**color_levels:** For 'curtain' plot only. Used only if "color_map_custom" is set to True.
419+
Define the number of distinct colors in the color bar (e.g., 30).
420+
421+
**color_map:** For 'curtain' plot only. Used only if "color_map_custom" is set to False
422+
(e.g., 'Spectral_r').
423+
424+
**vmin:** For 'curtain' plot only. Set y-axis minimum limit (e.g., 50).
425+
426+
**vmax:** For 'curtain' plot only. Set y-axis maximum limit (e.g., 1200).
427+
428+
**num_levels:** For 'curtain' plot only. Set the number of vertical levels for interpolation
429+
(e.g., 100).
430+
431+
**interval:** For 'curtain' plot only. Set the y-axis tick interval (e.g., 100).
432+
433+
**pressure_units:** For 'curtain' plot only. Units to use only for the y-axis label.
434+
No conversions occur. Current options are only 'hPa' and 'Pa'.
385435

386436
**data:** This a list of model / observation pairs to be plotted where the
387437
observation label is first and the model label is second
@@ -428,7 +478,26 @@ observation label is first and the model label is second
428478
* **ts_avg_window:** This is for timeseries plots only. This is the averaging
429479
window applied to the data. No averaging done if not provided in the yaml file (i.e., ts_avg_window is optional). Averaging is done if a pandas
430480
resample rule (e.g., 'H' is hourly, 'D' is daily) is specified.
431-
481+
* **altitude_yax2:** This is for "timeseries" plots for aircraft evaluation only.
482+
This allows users to add a secondary right y-axis to the timeseries plot. Additional YAML options
483+
are described below:
484+
485+
* **altitude_variable:** Name of altitude variable in observational
486+
dataset (e.g., altitude)
487+
* **altitude_ticks:** Option to set tick increments (e.g., 1000)
488+
* **ylabel2:** Option to set secondary right y-axis label (e.g., Altitude (m))
489+
* **plot_kwargs_y2:** Optional kwargs for secondary right y-axis (e.g., color: g)
490+
* **filter_dict:** Optionally provide the following options to specify the min and max
491+
values of altitude for the secondary right y-axis
492+
493+
* **altitude:**
494+
495+
* **oper:** Set to "between".
496+
* **value:** Set to a list of the vim and vmax (e., [2000,8000]).
497+
* **interquartile_style:** For "vert_profile" plot only. Specify 'shading' to
498+
plot shaded curves of the 25th and 75th percentile range of each vertical bin or
499+
'box' to plot box-plots of each vertical bin.
500+
432501
Stats
433502
-----
434503
All input needed to calculate the statistics. The supported statistics available

0 commit comments

Comments
 (0)