From 23fc4adf828b9c6326660de8f9ecedc45cbbac54 Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Mon, 9 Dec 2024 23:27:07 +0000 Subject: [PATCH] Per #3030, update docs by moving the gradient config entry from Grid-Stat to the common area and then referencing it in both Grid-Stat and Series-Analysis. --- docs/Users_Guide/config_options.rst | 26 ++++++++++++++++++++++++++ docs/Users_Guide/grid-stat.rst | 17 +---------------- docs/Users_Guide/series-analysis.rst | 7 +++++-- 3 files changed, 32 insertions(+), 18 deletions(-) diff --git a/docs/Users_Guide/config_options.rst b/docs/Users_Guide/config_options.rst index bdb3f201e4..4f7db166fd 100644 --- a/docs/Users_Guide/config_options.rst +++ b/docs/Users_Guide/config_options.rst @@ -2232,6 +2232,32 @@ This dictionary may include the following entries: prob_cat_thresh = []; } + +.. _gradient: + +gradient +-------- + +:ref:`gradient ` + +The "gradient" entry is a dictionary which specifies the number and size +of gradients to be computed and applies to both Grid-Stat and +Series-Analysis. The "dx" and "dy" entries specify the size of the +gradients in grid units in the X and Y dimensions, respectively. "dx" +and "dy" are arrays of integers (positive or negative) which must have the +same length, and the GRAD output line type will be computed separately for +each entry. When computing gradients, the value at the (x, y) grid point +is replaced by the value at the (x+dx, y+dy) grid point minus the value at +(x, y). This configuration option may be set separately in each "obs.field" +entry. + +.. code-block:: none + + gradient = { + dx = [ 1 ]; + dy = [ 1 ]; + } + output_flag ----------- diff --git a/docs/Users_Guide/grid-stat.rst b/docs/Users_Guide/grid-stat.rst index 22925d0b25..8e93392a72 100644 --- a/docs/Users_Guide/grid-stat.rst +++ b/docs/Users_Guide/grid-stat.rst @@ -270,6 +270,7 @@ __________________________ eclv_points = 0.05; hss_ec_value = NA; rank_corr_flag = TRUE; + gradient = { dx = [ 1 ]; dy = [ 1 ]; } grid_weight_flag = NONE; tmp_dir = "/tmp"; output_prefix = ""; @@ -326,22 +327,6 @@ The available wave numbers start at 0 (the mean across each row of data) and end _____________________ -.. _gradient: - -:ref:`gradient ` - -.. code-block:: none - - gradient = { - dx = [ 1 ]; - dy = [ 1 ]; - } - - -The **gradient** entry is a dictionary which specifies the number and size of gradients to be computed. The **dx** and **dy** entries specify the size of the gradients in grid units in the X and Y dimensions, respectively. **dx** and **dy** are arrays of integers (positive or negative) which must have the same length, and the GRAD output line type will be computed separately for each entry. When computing gradients, the value at the (x, y) grid point is replaced by the value at the (x+dx, y+dy) grid point minus the value at (x, y). This configuration option may be set separately in each **obs.field** entry. - -____________________ - .. _distance_map: :ref:`distance_map ` diff --git a/docs/Users_Guide/series-analysis.rst b/docs/Users_Guide/series-analysis.rst index ed9f5578ab..8c6c5f05b7 100644 --- a/docs/Users_Guide/series-analysis.rst +++ b/docs/Users_Guide/series-analysis.rst @@ -116,6 +116,7 @@ ____________________ boot = { interval = PCTILE; rep_prop = 1.0; n_rep = 1000; rng = "mt19937"; seed = ""; } mask = { grid = [ "FULL" ]; poly = []; } + gradient = { dx = [ 1 ]; dy = [ 1 ]; } hss_ec_value = NA; rank_corr_flag = TRUE; tmp_dir = "/tmp"; @@ -139,7 +140,6 @@ ____________________ Ratio of valid matched pairs for the series of values at each grid point required to compute statistics. Set to a lower proportion to allow some missing values. Setting it to 1.0 requires that every data point be valid over the series to compute statistics. - ____________________ .. code-block:: none @@ -157,6 +157,7 @@ ____________________ pstd = []; pjc = []; prc = []; + grad = []; } The output_stats array controls the type of output that the Series-Analysis tool generates. Each flag corresponds to an output line type in the STAT file and is used to specify the comma-separated list of statistics to be computed. Use the column names from the tables listed below to specify the statistics. The output flags correspond to the following types of output line types: @@ -185,4 +186,6 @@ The output_stats array controls the type of output that the Series-Analysis tool 12. PRC for Receiver Operating Characteristic for Probabilistic forecasts (See :numref:`table_PS_format_info_PRC`) -.. note:: When the -input option is used, all partial sum and contingency table count columns are required to aggregate statistics across multiple runs. To facilitate this, the output_stats entries for the CTC, SL1L2, SAL1L2, and PCT line types can be set to "ALL" to indicate that all available columns for those line types should be written. +13. GRAD for Gradient Statistics (See :numref:`table_GS_format_info_GRAD`) + +.. note:: When the -input option is used, all partial sum and contingency table count columns are required to aggregate statistics across multiple runs. To facilitate this, the output_stats entries for the CTC, SL1L2, SAL1L2, and PCT line types can be set to "ALL" to indicate that all available columns for those line types should be written.