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 28, 2022
1 parent 3474b0e commit 1d10948
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions met/docs/Users_Guide/mode-analysis.rst
Original file line number Diff line number Diff line change
@@ -1,31 +1,32 @@
.. _mode-analysis:

******************
MODE-Analysis Tool
==================
******************

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

Users may wish to summarize multiple ASCII files produced by MODE across many cases. The MODE output files contain many output columns making it very difficult to interpret the results by simply browsing the files. Furthermore, for particular applications some data fields in the MODE output files may not be of interest. The MODE-Analysis tool provides a simple way to compute basic summary statistics and filtering capabilities for these files. Users who are not proficient at writing scripts can use the tool directly, and even those using their own scripts can use this tool as a filter, to extract only the MODE output lines that are relevant for their application.

.. _MODE_A-Scientific-and-statistical:

Scientific and statistical aspects
__________________________________
==================================

The MODE-Analysis tool operates in two modes, called "summary" and "bycase". In summary mode, the user specifies on the command line the MODE output columns of interest as well as filtering criteria that determine which input lines should be used. For example, a user may be interested in forecast object areas, but only if the object was matched, and only if the object centroid is inside a particular region. The summary statistics generated for each specified column of data are the minimum, maximum, mean, standard deviation, and the 10th, 25th, 50th, 75th and 90th percentiles. In addition, the user may specify a "dump'" file: the individual MODE lines used to produce the statistics will be written to this file. This option provides the user with a filtering capability. The dump file will consist only of lines that match the specified criteria.

The other option for operating the analysis tool is "bycase". Given initial and final values for forecast lead time, the tool will output, for each valid time in the interval, the matched area, unmatched area, and the number of forecast and observed objects that were matched or unmatched. For the areas, the user can specify forecast or observed objects, and also simple or cluster objects. A dump file may also be specified in this mode.

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

The MODE-Analysis tool reads lines from MODE ASCII output files and applies filtering and computes basic statistics on the object attribute values. For each job type, filter parameters can be set to determine which MODE output lines are used. The following sections describe the mode_analysis usage statement, required arguments, and optional arguments.

.. _mode_analysis-usage:

mode_analysis usage
~~~~~~~~~~~~~~~~~~~
-------------------

The usage statement for the MODE-Analysis tool is shown below:

Expand Down Expand Up @@ -587,13 +588,13 @@ This option prints the usage message.
.. _mode_analysis-configuration-file:

mode_analysis configuration file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--------------------------------

To use the MODE-Analysis tool, the user must un-comment the options in the configuration file to apply them and comment out unwanted options. The options in the configuration file for the MODE-Analysis tools are the same as the MODE command line options described in :numref:`mode_analysis-usage`.

The parameters that are set in the configuration file either add to or override parameters that are set on the command line. For the "set string" and "set integer type" options enclosed in brackets, the values specified in the configuration file are added to any values set on the command line. For the "toggle" and "min/max type" options, the values specified in the configuration file override those set on the command line.

mode_analysis output
~~~~~~~~~~~~~~~~~~~~
--------------------

The output of the MODE-Analysis tool is a self-describing tabular format written to standard output. The length and contents of the table vary depending on whether **-summary** or **-bycase** is selected. The contents also change for **-summary** depending on the number of columns specified by the user.

0 comments on commit 1d10948

Please sign in to comment.