Skip to content

Commit

Permalink
Per #3032, remove the first row from each output table since its info…
Browse files Browse the repository at this point in the history
… is repeated from the table name. Additional changes for consistency and accuracy in column names.
  • Loading branch information
JohnHalleyGotway committed Dec 18, 2024
1 parent 49e9a65 commit 3498e59
Show file tree
Hide file tree
Showing 15 changed files with 99 additions and 417 deletions.
2 changes: 1 addition & 1 deletion docs/Users_Guide/appendixC.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ By dividing the counts in the cells by the overall total, T, the joint proportio

The values in :numref:`table_2X2` can also be used to compute the F, O, and H relative frequencies that are produced by the NCEP Verification System, and the Point-Stat tool provides an option to produce the statistics in this form. In terms of the other statistics computed by the Point-Stat tool, F is equivalent to the Mean Forecast; H is equivalent to POD; and O is equivalent to the Base Rate. All of these statistics are defined in the subsections below. The Point-Stat tool also provides the total number of observations, **T**.

The categorical verification measures produced by the Point-Stat and Grid-Stat tools are described in the following subsections. They are presented in the order shown in :numref:`table_PS_format_info_FHO` through :numref:`table_PS_format_info_CTS_cont`.
The categorical verification measures produced by the Point-Stat and Grid-Stat tools are described in the following subsections. They are presented in the order shown in :numref:`table_PS_format_info_FHO` through :numref:`table_PS_format_info_CTS`.

TOTAL
-----
Expand Down
50 changes: 9 additions & 41 deletions docs/Users_Guide/ensemble-stat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -518,14 +518,10 @@ The format of the STAT and ASCII output of the Ensemble-Stat tool are described

.. _table_ES_header_info_es_out:

.. list-table:: Header information for each file ensemble-stat outputs
.. list-table:: Header information for Ensemble-Stat STAT output
:widths: auto
:header-rows: 2
:header-rows: 1

* - HEADER
-
-
-
* - Column Number
- Header Column Name
- Description
Expand Down Expand Up @@ -631,12 +627,8 @@ The format of the STAT and ASCII output of the Ensemble-Stat tool are described

.. list-table:: Format information for ECNT (Ensemble Continuous Statistics) output line type.
:widths: auto
:header-rows: 2
:header-rows: 1

* - ECNT OUTPUT FORMAT
-
-
-
* - Column Number
- ECNT Column Name
- Description
Expand Down Expand Up @@ -758,12 +750,8 @@ The format of the STAT and ASCII output of the Ensemble-Stat tool are described

.. list-table:: Format information for RPS (Ranked Probability Score) output line type.
:widths: auto
:header-rows: 2
:header-rows: 1

* - RPS OUTPUT FORMAT
-
-
-
* - Column Number
- RPS Column Name
- Description
Expand Down Expand Up @@ -809,12 +797,8 @@ The format of the STAT and ASCII output of the Ensemble-Stat tool are described

.. list-table:: Format information for RHIST (Ranked Histogram) output line type.
:widths: auto
:header-rows: 2
:header-rows: 1

* - RHIST OUTPUT FORMAT
-
-
-
* - Column Number
- RHIST Column Name
- Description
Expand All @@ -840,12 +824,8 @@ The format of the STAT and ASCII output of the Ensemble-Stat tool are described

.. list-table:: Format information for PHIST (Probability Integral Transform Histogram) output line type.
:widths: auto
:header-rows: 2
:header-rows: 1

* - PHIST OUTPUT FORMAT
-
-
-
* - Column Number
- PHIST Column Name
- Description
Expand Down Expand Up @@ -875,12 +855,8 @@ The format of the STAT and ASCII output of the Ensemble-Stat tool are described

.. list-table:: Format information for RELP (Relative Position) output line type.
:widths: auto
:header-rows: 2
:header-rows: 1

* - RELP OUTPUT FORMAT
-
-
-
* - Column Number
- RELP Column Name
- Description
Expand All @@ -906,12 +882,8 @@ The format of the STAT and ASCII output of the Ensemble-Stat tool are described

.. list-table:: Format information for ORANK (Observation Rank) output line type.
:widths: auto
:header-rows: 2
:header-rows: 1

* - ORANK OUTPUT FORMAT
-
-
-
* - Column Number
- ORANK Column Name
- Description
Expand Down Expand Up @@ -1020,12 +992,8 @@ The format of the STAT and ASCII output of the Ensemble-Stat tool are described

.. list-table:: Format information for SSVAR (Spread/Skill Variance) output line type.
:widths: auto
:header-rows: 2
:header-rows: 1

* - SSVAR OUTPUT FORMAT
-
-
-
* - Column Number
- SSVAR Column Name
- Description
Expand Down
62 changes: 9 additions & 53 deletions docs/Users_Guide/grid-stat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -494,14 +494,10 @@ The format of the STAT and ASCII output of the Grid-Stat tool are the same as th

.. _table_GS_header_info_gs_outputs:

.. list-table:: Header information for each file grid-stat outputs
.. list-table:: Header information for Grid-Stat STAT output
:widths: auto
:header-rows: 2
:header-rows: 1

* - HEADER
-
-
-
* - Column Number
- Header Column Name
- Description
Expand Down Expand Up @@ -607,12 +603,8 @@ The format of the STAT and ASCII output of the Grid-Stat tool are the same as th

.. list-table:: Format information for NBRCTC (Neighborhood Contingency Table Counts) output line type
:widths: auto
:header-rows: 2
:header-rows: 1

* - NBRCTC OUTPUT FORMAT
-
-
-
* - Column Number
- NBRCTC Column Name
- Description
Expand Down Expand Up @@ -649,12 +641,8 @@ The format of the STAT and ASCII output of the Grid-Stat tool are the same as th

.. list-table:: Format information for NBRCTS (Neighborhood Contingency Table Statistics) output line type
:widths: auto
:header-rows: 2
:header-rows: 1

* - NBRCTS OUTPUT FORMAT
-
-
-
* - Column Number
- NBRCTS Column Name
- Description
Expand Down Expand Up @@ -707,20 +695,6 @@ The format of the STAT and ASCII output of the Grid-Stat tool are the same as th
- GSS, :raw-html:`<br />` GSS_BCL, :raw-html:`<br />` GSS_BCU
- Gilbert Skill Score including bootstrap upper and lower confidence limits
- Double

.. _table_GS_format_info_NBRCTS_cont:

.. role:: raw-html(raw)
:format: html

.. list-table:: Format information for NBRCTS (Neighborhood Contingency Table Statistics) output line type, continued from above
:widths: auto
:header-rows: 1

* - Column Number
- NBRCTS Column Name
- Description
- Data Type
* - 72-76
- HK, :raw-html:`<br />` HK_NCL, :raw-html:`<br />` HK_NCU, :raw-html:`<br />` HK_BCL, :raw-html:`<br />` HK_BCU
- Hanssen-Kuipers Discriminant including normal and bootstrap upper and lower confidence limits
Expand Down Expand Up @@ -770,12 +744,8 @@ The format of the STAT and ASCII output of the Grid-Stat tool are the same as th

.. list-table:: Format information for NBRCNT(Neighborhood Continuous Statistics) output line type
:widths: auto
:header-rows: 2
:header-rows: 1

* - NBRCNT OUTPUT FORMAT
-
-
-
* - Column Number
- NBRCNT Column Name
- Description
Expand Down Expand Up @@ -817,12 +787,8 @@ The format of the STAT and ASCII output of the Grid-Stat tool are the same as th

.. list-table:: Format information for GRAD (Gradient Statistics) output line type
:widths: auto
:header-rows: 2
:header-rows: 1

* - GRAD OUTPUT FORMAT
-
-
-
* - Column Number
- GRAD Column Name
- Description
Expand Down Expand Up @@ -876,12 +842,8 @@ The format of the STAT and ASCII output of the Grid-Stat tool are the same as th

.. list-table:: Format information for DMAP (Distance Map) output line type
:widths: auto
:header-rows: 2
:header-rows: 1

* - DMAP OUTPUT FORMAT
-
-
-
* - Column Number
- DMAP Column Name
- Description
Expand Down Expand Up @@ -995,10 +957,8 @@ The output NetCDF file contains the dimensions and variables shown in :numref:`t

.. list-table:: Dimensions defined in NetCDF matched pair output
:widths: auto
:header-rows: 2
:header-rows: 1

* - grid_stat NETCDF DIMENSIONS
-
* - NetCDF Dimension
- Description
* - Lat
Expand All @@ -1014,12 +974,8 @@ The output NetCDF file contains the dimensions and variables shown in :numref:`t

.. list-table:: A selection of variables that can appear in the NetCDF matched pair output
:widths: auto
:header-rows: 2
:header-rows: 1

* - grid_stat NETCDF VARIABLES
-
-
-
* - NetCDF Variable
- Dimension
- Description
Expand Down
24 changes: 4 additions & 20 deletions docs/Users_Guide/gsi-tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,12 +81,8 @@ The GSID2MPR tool writes the same set of MPR output columns for the conventional

.. list-table:: Format information for GSI Diagnostic Conventional MPR (Matched Pair) output line type.
:widths: auto
:header-rows: 2
:header-rows: 1

* - GSI DIAGNOSTIC CONVENTIONAL MPR OUTPUT FILE
-
-
-
* - Column Number
- Column Name
- Description
Expand Down Expand Up @@ -134,12 +130,8 @@ The GSID2MPR tool writes the same set of MPR output columns for the conventional

.. list-table:: Format information for GSI Diagnostic Radiance MPR (Matched Pair) output line type.
:widths: auto
:header-rows: 2
:header-rows: 1

* - GSI DIAGNOSTIC RADIANCE MPR OUTPUT FILE
-
-
-
* - Column Number
- Column Name
- Description
Expand Down Expand Up @@ -361,12 +353,8 @@ The GSID2MPR tool writes the same set of ORANK output columns for the convention

.. list-table:: Format information for GSI Diagnostic Conventional ORANK (Observation Rank) output line type.
:widths: auto
:header-rows: 2
:header-rows: 1

* - GSI DIAGNOSTIC CONVENTIONAL ORANK OUTPUT FILE
-
-
-
* - Column Number
- Column Name
- Description
Expand All @@ -391,12 +379,8 @@ The GSID2MPR tool writes the same set of ORANK output columns for the convention

.. list-table:: Format information for GSI Diagnostic Radiance ORANK (Observation Rank) output line type.
:widths: auto
:header-rows: 2
:header-rows: 1

* - GSI DIAGNOSTIC RADIANCE ORANK OUTPUT FILE
-
-
-
* - Column Number
- Column Name
- Description
Expand Down
42 changes: 13 additions & 29 deletions docs/Users_Guide/mode-td.rst
Original file line number Diff line number Diff line change
Expand Up @@ -384,12 +384,8 @@ The contents of the OBJECT_ID and OBJECT_CAT columns identify the objects using

.. list-table:: Text Header Columns
:widths: auto
:header-rows: 2
:header-rows: 1

* - HEADER
-
-
-
* - Column
- Name
- Description
Expand Down Expand Up @@ -485,16 +481,12 @@ The contents of the OBJECT_ID and OBJECT_CAT columns identify the objects using

.. _table_mtd-2D-Attributes:

.. list-table:: 2D Attribute
.. list-table:: 2D Object Attributes
:widths: auto
:header-rows: 2
:header-rows: 1

* - 2D Attribute Columns
-
-
-
* - Column
- Name
* - Column Number
- 2D Column Name
- Description
- Data Type
* - 23
Expand Down Expand Up @@ -536,16 +528,12 @@ The contents of the OBJECT_ID and OBJECT_CAT columns identify the objects using

.. _table_mtd-3D-single-attributes:

.. list-table:: 3D Single Attribute
.. list-table:: 3D Single Object Attributes
:widths: auto
:header-rows: 2
:header-rows: 1

* - 3D Single Attribute Columns
-
-
-
* - Column
- Name
* - Column Number
- 3D Single Column Name
- Description
- Data Type
* - 23
Expand Down Expand Up @@ -607,16 +595,12 @@ The contents of the OBJECT_ID and OBJECT_CAT columns identify the objects using

.. _table_mtd-3D-Pair-Attribute:

.. list-table:: 3D Pair Attribute
.. list-table:: 3D Pair Object Attributes
:widths: auto
:header-rows: 2
:header-rows: 1

* - 3D Pair Attribute Columns
-
-
-
* - Column
- Name
* - Column Number
- 3D Pair Column Name
- Description
- Data Type
* - 23
Expand Down
Loading

0 comments on commit 3498e59

Please sign in to comment.