Feature #2750 mtd_docs (#3014)

* Per #2750, user-provided should be hyphenated.

* Per #2750, add units to MTD output tables and specify order of forecast minus observation differences, where applicable. Also update some wording for consistency.

* Unrelated to #2750, but prior to the v12.0.0 release, create a 12.0.0 flowchart, save as PNG, and use it to update the overview figure.

* Per #2750, put X_DOT and Y_DOT back on separate lines since RTD interprets X_,Y_DOT as being a poorly defined link.

docs/Users_Guide/ensemble-stat.rst

@@ -533,10 +533,10 @@ The format of the STAT and ASCII output of the Ensemble-Stat tool are described
     - Version number
   * - 2
     - MODEL
-    - User provided text string designating model name
+    - User-provided text string designating model name
   * - 3
     - DESC
-    - User provided text string describing the verification task
+    - User-provided text string describing the verification task
   * - 4
     - FCST_LEAD
     - Forecast lead time in HHMMSS format

docs/Users_Guide/grid-stat.rst

@@ -509,10 +509,10 @@ The format of the STAT and ASCII output of the Grid-Stat tool are the same as th
     - Version number
   * - 2
     - MODEL
-    - User provided text string designating model name
+    - User-provided text string designating model name
   * - 3
     - DESC
-    - User provided text string describing the verification task
+    - User-provided text string describing the verification task
   * - 4
     - FCST_LEAD
     - Forecast lead time in HHMMSS format
@@ -551,7 +551,7 @@ The format of the STAT and ASCII output of the Grid-Stat tool are the same as th
     - Selected Vertical level for observations
   * - 16
     - OBTYPE
-    - User provided text string designating the observation type
+    - User-provided text string designating the observation type
   * - 17
     - VX_MASK
     - Verifying masking region indicating the masking grid or polyline region applied

docs/Users_Guide/mode-td.rst

@@ -397,10 +397,10 @@ The contents of the OBJECT_ID and OBJECT_CAT columns identify the objects using
     - Version number
   * - 2
     - MODEL
-    - User provided text string giving model name
+    - User-provided text string giving model name
   * - 3
     - DESC
-    - User provided text string describing the verification task
+    - User-provided text string describing the verification task
   * - 4
     - FCST_LEAD
     - Forecast lead time in HHMMSS format
@@ -482,40 +482,22 @@ The contents of the OBJECT_ID and OBJECT_CAT columns identify the objects using
     - Time index of slice
   * - 26
     - AREA
-    - 2D cross-sectional area
-  * - 27
-    - CENTROID_X
-    - x coordinate of centroid
-  * - 28
-    - CENTROID_Y
-    - y coordinate of centroid
-  * - 29
-    - CENTROID_LAT
-    - Latitude of centroid
-  * - 30
-    - CENTROID_LON
-    - Longitude of centroid
+    - 2D cross-sectional area (in grid squares)
+  * - 27-28
+    - CENTROID_X,_Y
+    - Location of centroid (in grid units)
+  * - 29-30
+    - CENTROID_LAT,_LON
+    - Location of centroid (in lat/lon degrees)
   * - 31
     - AXIS_ANG
-    - Angle that the axis makes with the grid x direction
-  * - 32
-    - INTENSITY_10
-    - :math:`\text{10}^{th}` percentile intensity in time slice
-  * - 33
-    - INTENSITY_25
-    - :math:`\text{25}^{th}` percentile intensity in time slice
-  * - 34
-    - INTENSITY_50
-    - :math:`\text{60}^{th}` percentile intensity in time slice
-  * - 35
-    - INTENSITY_75
-    - :math:`\text{75}^{th}` percentile intensity in time slice
-  * - 36
-    - INTENSITY_90
-    - :math:`\text{90}^{th}` percentile intensity in time slice
+    - Angle that the axis makes with the grid x direction (in degrees)
+  * - 32-36
+    - INTENSITY_10,_25,_50,_75,_90
+    - 10th, 25th, 50th, 75th, and 90th percentile intensity in time slice (various units)
   * - 37
-    - INTENSITY_*
-    - User-specified percentile intensity in time slice
+    - INTENSITY_NN
+    - User-specified percentile intensity in time slice (various units)
 
 .. _table_mtd-3D-single-attributes:
 
@@ -535,60 +517,42 @@ The contents of the OBJECT_ID and OBJECT_CAT columns identify the objects using
   * - 24
     - OBJECT_CAT
     - Object category
-  * - 25
-    - CENTROID_X
-    - x coordinate of centroid
-  * - 26
-    - CENTROID_Y
-    - y coordinate of centroid
+  * - 25-26
+    - CENTROID_X,_Y
+    - Location of the centroid (in grid units)
   * - 27
     - CENTROID_T
-    - t coordinate of centroid
-  * - 28
-    - CENTROID_LAT
-    - Latitude of centroid
-  * - 29
-    - CENTROID_LON
-    - Longitude of centroid
+    - Time coordinate of centroid (in time steps)
+  * - 28-29
+    - CENTROID_LAT,_LON
+    - Location of the centroid (in lat/lon degrees)
   * - 30
     - X_DOT
-    - x component of object velocity
+    - X component of object velocity (in grid units per time step)
   * - 31
     - Y_DOT
-    - y component of object velocity
+    - Y component of object velocity (in grid units per time step)
   * - 32
     - AXIS_ANG
-    - Angle that the axis plane of an object makes with the grid x direction
+    - Angle that the axis plane of an object makes with the grid x direction (in degrees)
   * - 33
     - VOLUME
-    - Integer count of the number of 3D "cells" in an object
+    - 3D object volume (integer count of 3D spacetime cells)
   * - 34
     - START_TIME
-    - Object start time
+    - Object start time (in time steps)
   * - 35
     - END_TIME
-    - Object end time
+    - Object end time (in time steps)
   * - 36
     - CDIST_TRAVELLED
-    - Total great circle distance travelled by the 2D spatial centroid over the lifetime of the 3D object
-  * - 37
-    - INTENSITY_10
-    - :math:`\text{10}^{th}` percentile intensity inside object
-  * - 38
-    - INTENSITY_25
-    - :math:`\text{25}^{th}` percentile intensity inside object
-  * - 39
-    - INTENSITY_50
-    - :math:`\text{50}^{th}` percentile intensity inside object
-  * - 40
-    - INTENSITY_75
-    - :math:`\text{75}^{th}` percentile intensity inside object
-  * - 41
-    - INTENSITY_90
-    - :math:`\text{90}^{th}` percentile intensity inside object
+    - Total great circle distance travelled by the 2D spatial centroid over the lifetime of the 3D object (in kilometers)
+  * - 37-41
+    - INTENSITY_10,_25,_50,_75,_90
+    - 10th, 25th, 50th, 75th, and 90th percentile intensity in spacetime object (various units)
   * - 42
-    - INTENSITY_*
-    - User-specified percentile intensity inside object
+    - INTENSITY_NN
+    - User-specified percentile intensity in spacetime object (various units)
 
 .. _table_mtd-3D-Pair-Attribute:
 
@@ -610,37 +574,37 @@ The contents of the OBJECT_ID and OBJECT_CAT columns identify the objects using
     - Object category
   * - 25
     - SPACE_CENTROID_DIST
-    - Spatial distance between :math:`(x,y)` coordinates of object spacetime centroid
+    - Cartesian distance between :math:`(x,y)` coordinates of object spacetime centroids (in grid units)
   * - 26
     - TIME_CENTROID_DELTA
-    - Difference in *t* index of object spacetime centroid
+    - Observation minus forecast difference in *t* temporal index of object spacetime centroid (in time steps)
   * - 27
     - AXIS_DIFF
-    - Difference in spatial axis plane angles
+    - Angle between the spatial axis plane angles (in degrees, from 0 to 90)
   * - 28
     - SPEED_DELTA
-    - Difference in object speeds
+    - Forecast minus observation speed difference (in grid units per time step)
   * - 29
     - DIRECTION_DIFF
-    - Difference in object direction of movement
+    - Difference in object direction of movement (in degrees, from 0 to 180)
   * - 30
     - VOLUME_RATIO
-    - Forecast object volume divided by observation object volume
+    - Forecast 3D object volume divided by observation 3D object volume (unitless)
   * - 31
     - START_TIME_DELTA
-    - Difference in object starting time steps
+    - Forecast minus observation starting time step (in time steps)
   * - 32
     - END_TIME_DELTA
-    - Difference in object ending time steps
+    - Forecast minus observation ending time step (in time steps)
   * - 33
     - INTERSECTION_VOLUME
-    - "Volume" of object intersection
+    - 3D object intersection volume (integer count of 3D spacetime cells)
   * - 34
     - DURATION_DIFF
-    - Difference in the lifetimes of the two objects
+    - Forecast minus observation difference in object lifetimes (in time steps)
   * - 35
     - INTEREST
-    - Total interest for this object pair
+    - Total interest for this object pair (unitless)
 
 **NetCDF File**
 

docs/Users_Guide/mode.rst

@@ -590,16 +590,16 @@ The MODE tool creates two ASCII output files. The first ASCII file contains cont
     - Version number
   * - 2
     - MODEL
-    - User provided text string designating model name
+    - User-provided text string giving model name
   * - 3
     - N_VALID
     - Number of valid data points
   * - 4
     - GRID_RES
-    - User provided nominal grid resolution
+    - User-provided nominal grid resolution
   * - 5
     - DESC
-    - User provided text string describing the verification task
+    - User-provided text string describing the verification task
   * - 6
     - FCST_LEAD
     - Forecast lead time in HHMMSS format
@@ -620,13 +620,13 @@ The MODE tool creates two ASCII output files. The first ASCII file contains cont
     - Observation accumulation time in HHMMSS format
   * - 12
     - FCST_RAD
-    - Forecast convolution radius in grid squares
+    - Forecast convolution radius in grid units 
   * - 13
     - FCST_THR
     - Forecast convolution threshold
   * - 14
     - OBS_RAD
-    - Observation convolution radius in grid squares
+    - Observation convolution radius in grid units 
   * - 15
     - OBS_THR
     - Observation convolution threshold
@@ -650,7 +650,7 @@ The MODE tool creates two ASCII output files. The first ASCII file contains cont
     - Observation vertical level
   * - 22
     - OBTYPE
-    - User provided observation type
+    - User-provided observation type
   * - 23
     - FIELD
     - Field type for this line:* RAW for the raw input fields * OBJECT for the resolved object fields
@@ -790,16 +790,16 @@ The contents of the columns in this ASCII file are summarized in :numref:`MODE_o
     - Version number
   * - 2
     - MODEL
-    - User provided text string designating model name
+    - User-provided text string designating model name
   * - 3
     - N_VALID
     - Number of valid data points
   * - 4
     - GRID_RES
-    - User provided nominal grid resolution
+    - User-provided nominal grid resolution
   * - 5
     - DESC
-    - User provided text string describing the verification task
+    - User-provided text string describing the verification task
   * - 6
     - FCST_LEAD
     - Forecast lead time in HHMMSS format
@@ -850,7 +850,7 @@ The contents of the columns in this ASCII file are summarized in :numref:`MODE_o
     - Observation vertical level
   * - 22
     - OBTYPE
-    - User provided observation type
+    - User-provided observation type
   * - 23
     - OBJECT_ID
     - Object numbered from 1 to the number of objects in each field

docs/Users_Guide/point-stat.rst

@@ -539,10 +539,10 @@ The first set of header columns are common to all of the output files generated
     - Version number
   * - 2
     - MODEL
-    - User provided text string designating model name
+    - User-provided text string designating model name
   * - 3
     - DESC
-    - User provided text string describing the verification task
+    - User-provided text string describing the verification task
   * - 4
     - FCST_LEAD
     - Forecast lead time in HHMMSS format

docs/Users_Guide/tc-gen.rst

@@ -506,7 +506,7 @@ TC-Gen produces output in STAT and, optionally, ASCII and NetCDF formats. The AS
     - Current ATCF Technique name
   * - 3
     - DESC
-    - User provided text string describing the "filter" options
+    - User-provided text string describing the "filter" options
   * - 4
     - FCST_LEAD
     - Forecast lead time in HHMMSS format

docs/Users_Guide/tc-rmw.rst

@@ -7,7 +7,7 @@ TC-RMW Tool
 Introduction
 ============
 
-The TC-RMW tool regrids tropical cyclone model data onto a moving range-azimuth grid centered on points along the storm track provided in ATCF format, most likely the adeck generated from the file. The radial grid spacing can be defined in kilometers or as a factor of the radius of maximum winds (RMW). The azimuthal grid spacing is defined in degrees clockwise from due east. If wind vector fields are specified in the configuration file, the radial and tangential wind components will be computed. Any regridding method available in MET can be used to interpolate data on the model output grid to the specified range-azimuth grid. The regridding will be done separately on each vertical level. The model data files must coincide with track points in a user provided ATCF formatted track file.
+The TC-RMW tool regrids tropical cyclone model data onto a moving range-azimuth grid centered on points along the storm track provided in ATCF format, most likely the adeck generated from the file. The radial grid spacing can be defined in kilometers or as a factor of the radius of maximum winds (RMW). The azimuthal grid spacing is defined in degrees clockwise from due east. If wind vector fields are specified in the configuration file, the radial and tangential wind components will be computed. Any regridding method available in MET can be used to interpolate data on the model output grid to the specified range-azimuth grid. The regridding will be done separately on each vertical level. The model data files must coincide with track points in a user-provided ATCF formatted track file.
 
 Practical Information
 =====================

docs/Users_Guide/wavelet-stat.rst

@@ -345,10 +345,10 @@ The format of the STAT and ASCII output of the Wavelet-Stat tool is similar to t
     - Version number
   * - 2
     - MODEL
-    - User provided text string designating model name
+    - User-provided text string designating model name
   * - 3
     - DESC
-    - User provided text string describing the verification task
+    - User-provided text string describing the verification task
   * - 4
     - FCST_LEAD
     - Forecast lead time in HHMMSS format
@@ -387,7 +387,7 @@ The format of the STAT and ASCII output of the Wavelet-Stat tool is similar to t
     - Selected Vertical level for observations
   * - 16
     - OBTYPE
-    - User provided text string designating the observation type
+    - User-provided text string designating the observation type
   * - 17
     - VX_MASK
     - Verifying masking region indicating the masking grid or polyline region applied