Skip to content

Commit

Permalink
standardizing TOC sections #1998
Browse files Browse the repository at this point in the history
  • Loading branch information
lisagoodrich committed Jan 31, 2022
1 parent bbe0944 commit b95960e
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions met/docs/Users_Guide/rmw-analysis.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
.. _rmw-analysis:

*****************
RMW-Analysis Tool
=================
*****************

Introduction
____________
============

The RMW-Analysis tool analyzes a set of output files generated by the TC-RMW tool. For each grid cell it aggregates variable statistics across the set and across the track points of the tc_rmw output files. The statistics are mean, standard deviation, minimum and maximum. Note that tc_rmw should be set to use the same scale factor of the radius of maximum winds (RMW) as the unit of range for its range-azimuth grid. The specified data variables on the range-azimuth-vertical grid then share a common range scale of RMW before aggregation by rmw_analysis.

Practical information
_____________________
=====================

rmw_analysis usage
~~~~~~~~~~~~~~~~~~
------------------

The following sections describe the usage statement, required arguments, and optional arguments for **rmw_analysis**.

Expand Down Expand Up @@ -46,7 +47,7 @@ Optional arguments for rmw_analysis
5. The **-v level** option indicates the desired level of verbosity. The contents of "level" will override the default setting of 2. Setting the verbosity to 0 will make the tool run with no log messages, while increasing the verbosity above 1 will increase the amount of logging.

rmw_analysis configuration file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-------------------------------

The default configuration file for the RMW-Analysis tool named **RMWAnalysisConfig_default** can be found in the installed *share/met/config/* directory. It is encouraged for users to copy these default files before modifying their contents. The contents of the configuration file are described in the subsections below.

Expand Down Expand Up @@ -86,6 +87,6 @@ The track filter options available in rmw_analysis and listed above are describe


rmw_analysis output file
~~~~~~~~~~~~~~~~~~~~~~~~
------------------------

The NetCDF output file will inherit the spatial grid from the first tc_rmw output file in the output file list. All tc_rmw files in this list must have the same grid dimension sizes. A NetCDF output error will result if that is not the case. For each data variable specified in the config file, four corresponding NetCDF variables will be written, e.g. TMP_mean, TMP_stdev, TMP_min, TMP_max. No track point dimension is retained in the rmw_analysis output.

0 comments on commit b95960e

Please sign in to comment.