From 448a4bd9fda1580cac6bd592cba8bc8e2cc9ae05 Mon Sep 17 00:00:00 2001 From: jprestop Date: Fri, 20 Nov 2020 16:21:46 -0700 Subject: [PATCH] Feature 1474 README (#1582) * Changed name of README and README_TC, modified references to those, and cleaned up some formatting. * Fixed formatting and language * Update data_io.rst * Update data_io.rst * Update config_options_tc.rst Co-authored-by: johnhg --- .../{README.rst => config_options.rst} | 22 ++++++++----------- .../{README_TC.rst => config_options_tc.rst} | 8 +++---- met/docs/Users_Guide/data_io.rst | 22 ++----------------- met/docs/Users_Guide/ensemble-stat.rst | 6 ++--- met/docs/Users_Guide/grid-diag.rst | 2 +- met/docs/Users_Guide/grid-stat.rst | 4 ++-- met/docs/Users_Guide/index.rst | 4 ++-- met/docs/Users_Guide/installation.rst | 2 +- met/docs/Users_Guide/masking.rst | 2 +- met/docs/Users_Guide/mode-td.rst | 2 +- met/docs/Users_Guide/mode.rst | 10 ++++----- met/docs/Users_Guide/plotting.rst | 4 ++-- met/docs/Users_Guide/point-stat.rst | 4 ++-- met/docs/Users_Guide/reformat_grid.rst | 4 ++-- met/docs/Users_Guide/reformat_point.rst | 14 ++++++------ met/docs/Users_Guide/rmw-analysis.rst | 4 ++-- met/docs/Users_Guide/series-analysis.rst | 2 +- met/docs/Users_Guide/stat-analysis.rst | 10 ++++----- met/docs/Users_Guide/tc-gen.rst | 4 ++-- met/docs/Users_Guide/tc-pairs.rst | 2 +- met/docs/Users_Guide/tc-rmw.rst | 2 +- met/docs/Users_Guide/tc-stat.rst | 8 +++---- met/docs/Users_Guide/wavelet-stat.rst | 2 +- 23 files changed, 61 insertions(+), 83 deletions(-) rename met/docs/Users_Guide/{README.rst => config_options.rst} (99%) rename met/docs/Users_Guide/{README_TC.rst => config_options_tc.rst} (99%) diff --git a/met/docs/Users_Guide/README.rst b/met/docs/Users_Guide/config_options.rst similarity index 99% rename from met/docs/Users_Guide/README.rst rename to met/docs/Users_Guide/config_options.rst index 9ea102f839..bfba78cc05 100644 --- a/met/docs/Users_Guide/README.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -1,17 +1,17 @@ -.. _README: +.. _config_options: -====================================== - README - Configuration File Overview -====================================== + +Configuration File Overview +=========================== The configuration files that control many of the MET tools contain formatted ASCII text. This format has been updated for MET version |version| and continues to be used in subsequent releases. -Settings common to multiple tools are described in the top part of this README +Settings common to multiple tools are described in the top part of this file and settings specific to individual tools are described beneath the common -settings. Please refer to the MET User's Guide in the "doc" directory for more -details about the settings if necessary. +settings. Please refer to the MET User's Guide for more details about the +settings if necessary. A configuration file entry is an entry name, followed by an equal sign (=), followed by an entry value, and is terminated by a semicolon (;). The @@ -288,12 +288,8 @@ References: | -Configuration settings used by the MET tools -============================================ - - Settings common to multiple tools ---------------------------------- +_________________________________ **exit_on_warning** @@ -2174,7 +2170,7 @@ are empty. Note: grib_code 11 is equivalent to obs_var "TMP". } Settings specific to individual tools -------------------------------------- +_____________________________________ EnsembleStatConfig_default ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/met/docs/Users_Guide/README_TC.rst b/met/docs/Users_Guide/config_options_tc.rst similarity index 99% rename from met/docs/Users_Guide/README_TC.rst rename to met/docs/Users_Guide/config_options_tc.rst index 05a3f9ed55..155a394ed0 100644 --- a/met/docs/Users_Guide/README_TC.rst +++ b/met/docs/Users_Guide/config_options_tc.rst @@ -1,9 +1,9 @@ -.. _README_TC: +.. _config_options_tc: -README_TC Configuration File Overview -===================================== +Tropical Cyclone Configuration Options +====================================== -See :ref:`README` +See :numref:`config_options` for a description of the configuration file syntax. Configuration settings common to multiple tools _______________________________________________ diff --git a/met/docs/Users_Guide/data_io.rst b/met/docs/Users_Guide/data_io.rst index 0fde832667..fc3e062a1e 100644 --- a/met/docs/Users_Guide/data_io.rst +++ b/met/docs/Users_Guide/data_io.rst @@ -251,26 +251,8 @@ The following is a summary of the input and output formats for each of the tools Configuration File Details __________________________ -Part of the strength of MET is the leveraging of capability across tools. There are several config options that are common to many of the tools. They are described in this section. +Part of the strength of MET is the leveraging of capability across tools. There are several configuration options that are common to many of the tools. Many of the MET tools use a configuration file to set parameters. This prevents the command line from becoming too long and cumbersome and makes the output easier to duplicate. -Settings common to multiple tools are described in the following sections while those specific to individual tools are explained in the sections for those tools. In addition, these configuration settings are described in the *README* file and the *README_TC* file for the MET-Tropical Cyclone tools. - -.. _Data IO MET Configuration File Options: - -MET Configuration File Options -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The information listed below may also be found in the *README* file. - -:ref:`README` - -.. _Data IO MET-TC Configuration File Options: - -MET-TC Configuration File Options -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The information listed below may also be found in the *README_TC* file. - -:ref:`README_TC` +The configuration file details are described in :ref:`config_options` and :ref:`config_options_tc`. diff --git a/met/docs/Users_Guide/ensemble-stat.rst b/met/docs/Users_Guide/ensemble-stat.rst index 18810cb877..cc81dc357b 100644 --- a/met/docs/Users_Guide/ensemble-stat.rst +++ b/met/docs/Users_Guide/ensemble-stat.rst @@ -147,7 +147,7 @@ ____________________ output_prefix = ""; version = "VN.N"; -The configuration options listed above are common to many MET tools and are described in :numref:`Data IO MET Configuration File Options`. +The configuration options listed above are common to many MET tools and are described in :numref:`config_options`. _____________________ @@ -244,7 +244,7 @@ ____________________ prob_cat_thresh = []; -Setting up the **fcst** and **obs** dictionaries of the configuration file is described in :numref:`Data IO MET Configuration File Options`. The following are some special considerations for the Ensemble-Stat tool. +Setting up the **fcst** and **obs** dictionaries of the configuration file is described in :numref:`config_options`. The following are some special considerations for the Ensemble-Stat tool. The **ens** and **fcst** dictionaries do not need to include the same fields. Users may specify any number of ensemble fields to be summarized, but generally there are many fewer fields with verifying observations available. The **ens** dictionary specifies the fields to be summarized while the **fcst** dictionary specifies the fields to be verified. @@ -396,7 +396,7 @@ The **rng** group defines the random number generator **type** and **seed** to b The **seed** variable may be set to a specific value to make the assignment of ranks fully repeatable. When left empty, as shown above, the random number generator seed is chosen automatically which will lead to slightly different bootstrap confidence intervals being computed each time the data is run. -Refer to the description of the **boot** entry in :numref:`Data IO MET Configuration File Options` for more details on the random number generator. +Refer to the description of the **boot** entry in :numref:`config_options` for more details on the random number generator. ensemble_stat output diff --git a/met/docs/Users_Guide/grid-diag.rst b/met/docs/Users_Guide/grid-diag.rst index a38b058e3c..da2694d319 100644 --- a/met/docs/Users_Guide/grid-diag.rst +++ b/met/docs/Users_Guide/grid-diag.rst @@ -66,7 +66,7 @@ _____________________ mask = { grid = ""; poly = ""; } version = "VN.N"; -The configuration options listed above are common to many MET tools and are described in :numref:`Data IO MET Configuration File Options`. +The configuration options listed above are common to many MET tools and are described in :numref:`config_options`. _____________________ diff --git a/met/docs/Users_Guide/grid-stat.rst b/met/docs/Users_Guide/grid-stat.rst index 116cd0f115..d43555030b 100644 --- a/met/docs/Users_Guide/grid-stat.rst +++ b/met/docs/Users_Guide/grid-stat.rst @@ -60,7 +60,7 @@ The confidence intervals for the Grid-Stat tool are the same as those provided f Grid weighting ~~~~~~~~~~~~~~ -When computing continuous statistics on a regular large scale or global latitude-longitude grid, weighting may be applied in order to compensate for the meridian convergence toward higher latitudes. Grid square area weighting or weighting based on the cosine of the latitude are two configuration options in both point-stat and grid-stat. See :numref:`Data IO MET Configuration File Options` for more information. +When computing continuous statistics on a regular large scale or global latitude-longitude grid, weighting may be applied in order to compensate for the meridian convergence toward higher latitudes. Grid square area weighting or weighting based on the cosine of the latitude are two configuration options in both point-stat and grid-stat. See :numref:`config_options` for more information. Neighborhood methods ~~~~~~~~~~~~~~~~~~~~ @@ -227,7 +227,7 @@ __________________________ output_prefix = ""; version = "VN.N"; -The configuration options listed above are common to many MET tools and are described in :numref:`Data IO MET Configuration File Options`. +The configuration options listed above are common to many MET tools and are described in :numref:`config_options`. ___________________________ diff --git a/met/docs/Users_Guide/index.rst b/met/docs/Users_Guide/index.rst index a5f6583c22..e687d3ac5e 100644 --- a/met/docs/Users_Guide/index.rst +++ b/met/docs/Users_Guide/index.rst @@ -47,6 +47,8 @@ The National Center for Atmospheric Research (NCAR) is sponsored by NSF. The DTC overview installation data_io + config_options + config_options_tc reformat_point reformat_grid masking @@ -69,8 +71,6 @@ The National Center for Atmospheric Research (NCAR) is sponsored by NSF. The DTC tc-rmw rmw-analysis plotting - README - README_TC refs appendixA appendixB diff --git a/met/docs/Users_Guide/installation.rst b/met/docs/Users_Guide/installation.rst index 6b4eb2e4e4..e018a1ba30 100644 --- a/met/docs/Users_Guide/installation.rst +++ b/met/docs/Users_Guide/installation.rst @@ -119,7 +119,7 @@ As described in the introduction to this section, two additional utilities are s MET directory structure _______________________ -The top-level MET directory consists of a README file, Makefiles, configuration files, and several subdirectories. The top-level Makefile and configuration files control how the entire toolkit is built. Instructions for using these files to build MET can be found in :numref:`Install_Building-the-MET`. +The top-level MET directory consists of Makefiles, configuration files, and several subdirectories. The top-level Makefile and configuration files control how the entire toolkit is built. Instructions for using these files to build MET can be found in :numref:`Install_Building-the-MET`. When MET has been successfully built and installed, the installation directory contains two subdirectories. The bin/ directory contains executables for each module of MET as well as several plotting utilities. The share/met/ directory contains many subdirectories with data required at runtime and a subdirectory of sample R scripts utilities. The colortables/, map/, and ps/ subdirectories contain data used in creating PostScript plots for several MET tools. The poly/ subdirectory contains predefined lat/lon polyline regions for use in selecting regions over which to verify. The polylines defined correspond to verification regions used by NCEP as described in :numref:`Appendix B, Section %s `. The config/ directory contains default configuration files for the MET tools. The python/ subdirectory contains sample scripts used in Python embedding (:numref:`Appendix F, Section %s `). The table_files/ and tc_data/ subdirectories contain GRIB table definitions and tropical cyclone data, respectively. The Rscripts/ subdirectory contains a handful of plotting graphic utilities for MET-TC. These are the same Rscripts that reside under the top-level MET scripts/Rscripts directory, other than it is the installed location. The wrappers/ subdirectory contains code used in Python embedding (:numref:`Appendix F, Section %s `). diff --git a/met/docs/Users_Guide/masking.rst b/met/docs/Users_Guide/masking.rst index 0e64ac9b59..b052528e99 100644 --- a/met/docs/Users_Guide/masking.rst +++ b/met/docs/Users_Guide/masking.rst @@ -164,4 +164,4 @@ In this example, the Gen-Vx-Mask tool will read the ASCII Lat/Lon file named **C Feature-Relative Methods ________________________ -This section contains a description of several methods that may be used to perform feature-relative (or event -based) evaluation. The methodology pertains to examining the environment surrounding a particular feature or event such as a tropical, extra-tropical cyclone, convective cell, snow-band, etc. Several approaches are available for these types of investigations including applying masking described above (e.g. circle or box) or using the “FORCE” interpolation method in the regrid configuration option (see :numref:`Data IO MET Configuration File Options`). These methods generally require additional scripting, including potentially storm-track identification, outside of MET to be paired with the features of the MET tools. METplus may be used to execute this type of analysis. Please refer to the `METplus User's Guide `__. +This section contains a description of several methods that may be used to perform feature-relative (or event -based) evaluation. The methodology pertains to examining the environment surrounding a particular feature or event such as a tropical, extra-tropical cyclone, convective cell, snow-band, etc. Several approaches are available for these types of investigations including applying masking described above (e.g. circle or box) or using the “FORCE” interpolation method in the regrid configuration option (see :numref:`config_options`). These methods generally require additional scripting, including potentially storm-track identification, outside of MET to be paired with the features of the MET tools. METplus may be used to execute this type of analysis. Please refer to the `METplus User's Guide `__. diff --git a/met/docs/Users_Guide/mode-td.rst b/met/docs/Users_Guide/mode-td.rst index 6f9d4d88f3..1c885eca29 100644 --- a/met/docs/Users_Guide/mode-td.rst +++ b/met/docs/Users_Guide/mode-td.rst @@ -253,7 +253,7 @@ ______________________ output_prefix = ""; version = "VN.N"; -The configuration options listed above are common to many MET tools and are described in :numref:`Data IO MET Configuration File Options`. +The configuration options listed above are common to many MET tools and are described in :numref:`config_options`. ______________________ diff --git a/met/docs/Users_Guide/mode.rst b/met/docs/Users_Guide/mode.rst index 2e66848c64..6e62f8398b 100644 --- a/met/docs/Users_Guide/mode.rst +++ b/met/docs/Users_Guide/mode.rst @@ -195,7 +195,7 @@ _____________________ output_prefix = ""; version = "VN.N"; -The configuration options listed above are common to many MET tools and are described in :numref:`Data IO MET Configuration File Options`. +The configuration options listed above are common to many MET tools and are described in :numref:`config_options`. _____________________ @@ -239,9 +239,9 @@ _____________________ } obs = fcst; -The **field** entries in the forecast and observation dictionaries specify the model and observation variables and level to be compared. See a more complete description of them in :numref:`Data IO MET Configuration File Options`. In the above example, the forecast settings are copied into the observation dictionary using **obs = fcst;.** +The **field** entries in the forecast and observation dictionaries specify the model and observation variables and level to be compared. See a more complete description of them in :numref:`config_options`. In the above example, the forecast settings are copied into the observation dictionary using **obs = fcst;.** -The **censor_thresh** and **censor_val** entries are used to censor the raw data as described in :numref:`Data IO MET Configuration File Options`. Their functionality replaces the **raw_thresh** entry, which is deprecated in met-6.1. Prior to defining objects, it is recommended that the raw fields should be made to look similar to each other. For example, if the model only predicts values for a variable above some threshold, the observations should be thresholded at that same level. The censor thresholds can be specified using symbols. By default, no censor thresholding is applied. +The **censor_thresh** and **censor_val** entries are used to censor the raw data as described in :numref:`config_options`. Their functionality replaces the **raw_thresh** entry, which is deprecated in met-6.1. Prior to defining objects, it is recommended that the raw fields should be made to look similar to each other. For example, if the model only predicts values for a variable above some threshold, the observations should be thresholded at that same level. The censor thresholds can be specified using symbols. By default, no censor thresholding is applied. The **conv_radius** entry defines the radius of the circular convolution applied to smooth the raw fields. The radii are specified in terms of grid units. The default convolution radii are defined in terms of the previously defined **grid_res** entry. Multiple convolution radii may be specified as an array (e.g. **conv_radius = [ 5, 10, 15 ];**). @@ -329,7 +329,7 @@ _____________________ poly_flag = NONE; // Apply to NONE, FCST, OBS, or BOTH } -Defining a **grid** and **poly** masking region is described in :numref:`Data IO MET Configuration File Options`. Applying a masking region when running MODE sets all grid points falling outside of that region to missing data, effectively limiting the area of which objects should be defined. +Defining a **grid** and **poly** masking region is described in :numref:`config_options`. Applying a masking region when running MODE sets all grid points falling outside of that region to missing data, effectively limiting the area of which objects should be defined. The **grid_flag** and **poly_flag** entries specify how the grid and polyline masking should be applied: @@ -425,7 +425,7 @@ _____________________ color_table = "MET_BASE/colortables/mode_obj.ctable"; } -Specifying dictionaries to define the **color_table, plot_min**, and **plot_max** entries are described in :numref:`Data IO MET Configuration File Options`. +Specifying dictionaries to define the **color_table, plot_min**, and **plot_max** entries are described in :numref:`config_options`. The MODE tool generates a color bar to represent the contents of the colortable that was used to plot a field of data. The number of entries in the color bar matches the number of entries in the color table. The values defined for each color in the color table are also plotted next to the color bar. diff --git a/met/docs/Users_Guide/plotting.rst b/met/docs/Users_Guide/plotting.rst index fde50a105c..c102e6940f 100644 --- a/met/docs/Users_Guide/plotting.rst +++ b/met/docs/Users_Guide/plotting.rst @@ -91,7 +91,7 @@ ______________________ The **grid_data** dictionary defines a gridded field of data to be plotted as a base image prior to plotting point locations on top of it. The data to be plotted is specified by the **field** array. If **field** is empty, no base image will be plotted. If **field** has length one, the requested data will be read from the input file specified by the **-plot_grid** command line argument. -The **grid_plot_info** dictionary inside **grid_data** specifies the options for for plotting the gridded data. The options within **grid_plot_info** are described in :numref:`Data IO MET Configuration File Options`. +The **grid_plot_info** dictionary inside **grid_data** specifies the options for for plotting the gridded data. The options within **grid_plot_info** are described in :numref:`config_options`. ______________________ @@ -153,7 +153,7 @@ ______________________ censor_thresh = []; censor_val = []; -The **convert(x)** function, **censor_thresh** option, and **censor_val** option may be specified separately for each **point_data** array entry to transform the observation values prior to plotting. These options are further described in :numref:`Data IO MET Configuration File Options`. +The **convert(x)** function, **censor_thresh** option, and **censor_val** option may be specified separately for each **point_data** array entry to transform the observation values prior to plotting. These options are further described in :numref:`config_options`. ______________________ diff --git a/met/docs/Users_Guide/point-stat.rst b/met/docs/Users_Guide/point-stat.rst index f86e8bd06d..01336cc0af 100644 --- a/met/docs/Users_Guide/point-stat.rst +++ b/met/docs/Users_Guide/point-stat.rst @@ -345,11 +345,11 @@ ________________________ output_prefix = ""; version = "VN.N"; -The configuration options listed above are common to many MET tools and are described in :numref:`Data IO MET Configuration File Options`. +The configuration options listed above are common to many MET tools and are described in :numref:`config_options`. _________________________ -Setting up the **fcst** and **obs** dictionaries of the configuration file is described in :numref:`Data IO MET Configuration File Options`. The following are some special considerations for the Point-Stat tool. +Setting up the **fcst** and **obs** dictionaries of the configuration file is described in :numref:`config_options`. The following are some special considerations for the Point-Stat tool. The **obs** dictionary looks very similar to the **fcst** dictionary. When the forecast and observation variables follow the same naming convention, one can easily copy over the forecast settings to the observation dictionary using **obs = fcst;**. However when verifying forecast data in NetCDF format or verifying against not-standard observation variables, users will need to specify the **fcst** and **obs** dictionaries separately. The number of fields specified in the **fcst** and **obs** dictionaries must match. diff --git a/met/docs/Users_Guide/reformat_grid.rst b/met/docs/Users_Guide/reformat_grid.rst index b53fe37b20..9518cb0121 100644 --- a/met/docs/Users_Guide/reformat_grid.rst +++ b/met/docs/Users_Guide/reformat_grid.rst @@ -264,7 +264,7 @@ Optional arguments for regrid_data_plane 14. The **-compress level** option specifies the desired level of compression (deflate level) for NetCDF variables. The valid level is between 0 and 9. Setting the compression level to 0 will make no compression for the NetCDF output. Lower number is for fast compression and higher number is for better compression. -For more details on setting the **to_grid, -method, -width,** and **-vld_thresh** options, see the regrid entry in :numref:`Data IO MET Configuration File Options`. An example of the regrid_data_plane calling sequence is shown below: +For more details on setting the **to_grid, -method, -width,** and **-vld_thresh** options, see the regrid entry in :numref:`config_options`. An example of the regrid_data_plane calling sequence is shown below: .. code-block:: none @@ -341,7 +341,7 @@ Optional arguments for shift_data_plane 11. The **-compress level** option indicates the desired level of compression (deflate level) for NetCDF variables. The valid level is between 0 and 9. The value of “level” will override the default setting of 0 from the configuration file or the environment variable MET_NC_COMPRESS. Setting the compression level to 0 will make no compression for the NetCDF output. Lower number is for fast compression and higher number is for better compression. -For more details on setting the **-method** and **-width** options, see the **regrid** entry in :numref:`Data IO MET Configuration File Options`. An example of the shift_data_plane calling sequence is shown below: +For more details on setting the **-method** and **-width** options, see the **regrid** entry in :numref:`config_options`. An example of the shift_data_plane calling sequence is shown below: .. code-block:: none diff --git a/met/docs/Users_Guide/reformat_point.rst b/met/docs/Users_Guide/reformat_point.rst index 6f780788fe..4aa93baa23 100644 --- a/met/docs/Users_Guide/reformat_point.rst +++ b/met/docs/Users_Guide/reformat_point.rst @@ -114,7 +114,7 @@ ____________________ tmp_dir = "/tmp"; version = "VN.N"; -The configuration options listed above are common to many MET tools and are described in :numref:`Data IO MET Configuration File Options`. +The configuration options listed above are common to many MET tools and are described in :numref:`config_options`. _____________________ @@ -122,7 +122,7 @@ _____________________ message_type = []; -Each PrepBUFR message is tagged with one of eighteen message types as listed in the *share/met/config/README* file. The **message_type** refers to the type of observation from which the observation value (or 'report') was derived. The user may specify a comma-separated list of message types to be retained. Providing an empty list indicates that all message types should be retained. +Each PrepBUFR message is tagged with one of eighteen message types as listed in the :numref:`config_options` file. The **message_type** refers to the type of observation from which the observation value (or 'report') was derived. The user may specify a comma-separated list of message types to be retained. Providing an empty list indicates that all message types should be retained. ___________________ @@ -418,7 +418,7 @@ Each NetCDF file generated by the PB2NC tool contains the dimensions and variabl ASCII2NC tool _____________ -This section describes how to run the ASCII2NC tool. The ASCII2NC tool is used to reformat ASCII point observations into the NetCDF format expected by the Point-Stat tool. For those users wishing to verify against point observations that are not available in PrepBUFR format, the ASCII2NC tool provides a way of incorporating those observations into MET. If the ASCII2NC tool is used to perform a reformatting step, no configuration file is needed. However, for more complex processing, such as summarizing time series observations, a configuration file may be specified. For details on the configuration file options, see the *share/met/config/README* file and example configuration files distributed with the MET code. +This section describes how to run the ASCII2NC tool. The ASCII2NC tool is used to reformat ASCII point observations into the NetCDF format expected by the Point-Stat tool. For those users wishing to verify against point observations that are not available in PrepBUFR format, the ASCII2NC tool provides a way of incorporating those observations into MET. If the ASCII2NC tool is used to perform a reformatting step, no configuration file is needed. However, for more complex processing, such as summarizing time series observations, a configuration file may be specified. For details on the configuration file options, see :numref:`config_options` and example configuration files distributed with the MET code. Initial versions of the ASCII2NC tool supported only a simple 11 column ASCII point observation format. It currently supports point observation data in the following formats: the default 11 column format, little_r format, `SURFace RADiation (SURFRAD) `_ and Integrated Surface Irradiance Study (ISIS) formats, the Western Wind and Solar Integration Study (WWSIS) format, and the `AErosol RObotic NEtwork (AERONET) versions 2 and 3 format. `_ WWSIS data are available by request from National Renewable Energy Laboratory (NREL) in Boulder, CO. @@ -511,7 +511,7 @@ Optional arguments for ascii2nc 6. The **-mask_poly** file option is a polyline masking file to filter the point observations spatially. -7. The **-mask_sid** file|list option is a station ID masking file or a comma-separated list of station ID's to filter the point observations spatially. See the description of the “sid” entry in :numref:`Data IO MET Configuration File Options`. +7. The **-mask_sid** file|list option is a station ID masking file or a comma-separated list of station ID's to filter the point observations spatially. See the description of the “sid” entry in :numref:`config_options`. 8. The **-log file** option directs output and errors to the specified log file. All messages will be written to that file as well as standard out and error. Thus, users can save the messages without having to redirect the output on the command line. The default behavior is no log file. @@ -556,7 +556,7 @@ __________________ version = "VN.N"; -The configuration options listed above are common to many MET tools and are described in :numref:`Data IO MET Configuration File Options`. +The configuration options listed above are common to many MET tools and are described in :numref:`config_options`. _________________ @@ -662,7 +662,7 @@ Optional arguments for madis2nc 9. The **-mask_poly file** option defines a polyline masking file for filtering the point observations spatially. -10. The **-mask_sid file|list** option is a station ID masking file or a comma-separated list of station ID's for filtering the point observations spatially. See the description of the “sid” entry in :numref:`Data IO MET Configuration File Options`. +10. The **-mask_sid file|list** option is a station ID masking file or a comma-separated list of station ID's for filtering the point observations spatially. See the description of the “sid” entry in :numref:`config_options`. 11. The **-log file** option directs output and errors to the specified log file. All messages will be written to that file as well as standard out and error. Thus, users can save the messages without having to redirect the output on the command line. The default behavior is no log file. @@ -702,7 +702,7 @@ _________________ version = "VN.N"; -The configuration options listed above are common to many MET tools and are described in :numref:`Data IO MET Configuration File Options`. +The configuration options listed above are common to many MET tools and are described in :numref:`config_options`. __________________ diff --git a/met/docs/Users_Guide/rmw-analysis.rst b/met/docs/Users_Guide/rmw-analysis.rst index a7b4a516ca..4fe1cd41c0 100644 --- a/met/docs/Users_Guide/rmw-analysis.rst +++ b/met/docs/Users_Guide/rmw-analysis.rst @@ -63,7 +63,7 @@ ______________________ ]; } -The configuration options listed above are common to many MET tools and are described in :numref:`Data IO MET Configuration File Options`. +The configuration options listed above are common to many MET tools and are described in :numref:`config_options`. ____________________ @@ -81,7 +81,7 @@ ____________________ valid_mask = ""; version = "VN.N"; -The track filter options available in rmw_analysis and listed above are described in :numref:`Data IO MET-TC Configuration File Options`. +The track filter options available in rmw_analysis and listed above are described in :numref:`config_options`. diff --git a/met/docs/Users_Guide/series-analysis.rst b/met/docs/Users_Guide/series-analysis.rst index 904a619255..61bbb3ada9 100644 --- a/met/docs/Users_Guide/series-analysis.rst +++ b/met/docs/Users_Guide/series-analysis.rst @@ -114,7 +114,7 @@ ____________________ tmp_dir = "/tmp"; version = "VN.N"; -The configuration options listed above are common to many MET tools and are described in :numref:`Data IO MET Configuration File Options`. +The configuration options listed above are common to many MET tools and are described in :numref:`config_options`. ____________________ diff --git a/met/docs/Users_Guide/stat-analysis.rst b/met/docs/Users_Guide/stat-analysis.rst index 94d5697580..e54d7c0ca2 100644 --- a/met/docs/Users_Guide/stat-analysis.rst +++ b/met/docs/Users_Guide/stat-analysis.rst @@ -270,7 +270,7 @@ ________________________ tmp_dir = "/tmp"; version = "VN.N"; -The configuration options listed above are common to many MET tools and are described in :numref:`Data IO MET Configuration File Options`. +The configuration options listed above are common to many MET tools and are described in :numref:`config_options`. ___________________ @@ -471,7 +471,7 @@ ___________________ out_alpha = 0.05; -This entry specifies the alpha value to be used when computing confidence intervals for output statistics. It is similar to the **ci_alpha** entry described in :numref:`Data IO MET Configuration File Options`. +This entry specifies the alpha value to be used when computing confidence intervals for output statistics. It is similar to the **ci_alpha** entry described in :numref:`config_options`. ___________________ @@ -514,7 +514,7 @@ This job command option is extremely useful. It can be used multiple times to sp -column_thresh col_name thresh -column_str col_name string -The column filtering options may be used when the **-line_type** has been set to a single value. These options take two arguments, the name of the data column to be used followed by a value, string, or threshold to be applied. If multiple column_min/max/eq/thresh/str options are listed, the job will be performed on their intersection. Each input line is only retained if its value meets the numeric filtering criteria defined or matches one of the strings defined by the **-column_str** option. Multiple filtering strings may be listed using commas. Defining thresholds in MET is described in :numref:`Data IO MET Configuration File Options`. +The column filtering options may be used when the **-line_type** has been set to a single value. These options take two arguments, the name of the data column to be used followed by a value, string, or threshold to be applied. If multiple column_min/max/eq/thresh/str options are listed, the job will be performed on their intersection. Each input line is only retained if its value meets the numeric filtering criteria defined or matches one of the strings defined by the **-column_str** option. Multiple filtering strings may be listed using commas. Defining thresholds in MET is described in :numref:`config_options`. .. code-block:: none @@ -550,7 +550,7 @@ The example above reads MPR lines, stratifies the data by forecast variable name -mask_poly file -mask_sid file|list -When processing input MPR lines, these options may be used to define a masking grid, polyline, or list of station ID's to filter the matched pair data geographically prior to computing statistics. The **-mask_sid** option is a station ID masking file or a comma-separated list of station ID's for filtering the matched pairs spatially. See the description of the “sid” entry in :numref:`Data IO MET Configuration File Options`. +When processing input MPR lines, these options may be used to define a masking grid, polyline, or list of station ID's to filter the matched pair data geographically prior to computing statistics. The **-mask_sid** option is a station ID masking file or a comma-separated list of station ID's for filtering the matched pairs spatially. See the description of the “sid” entry in :numref:`config_options`. .. code-block:: none @@ -686,7 +686,7 @@ The output from this job consists of three lines, the first two of which contain The ramp job operates on a time-series of forecast and observed values and is analogous to the RIRW (Rapid Intensification and Weakening) job described in :numref:`tc_stat-output`. The amount of change from one time to the next is computed for forecast and observed values. Those changes are thresholded to define events which are used to populate a 2x2 contingency table. -See the README file in the installed share/met/config directory for a detailed description of the job command options available for ramp job type. +See :numref:`config_options` for a detailed description of the job command options available for ramp job type. The default output for this job is contingency table counts and statistics (**-out_line_type CTC,CTS**). Matched pair information may also be output by requesting MPR output (**-out_line_type CTC,CTS,MPR**). diff --git a/met/docs/Users_Guide/tc-gen.rst b/met/docs/Users_Guide/tc-gen.rst index 7a5bdb7cad..67c3525d29 100644 --- a/met/docs/Users_Guide/tc-gen.rst +++ b/met/docs/Users_Guide/tc-gen.rst @@ -151,7 +151,7 @@ ______________________ desc = "NA"; -The **desc** configuration option is common to many MET tools and is described in :numref:`Data IO MET Configuration File Options`. +The **desc** configuration option is common to many MET tools and is described in :numref:`config_options`. ______________________ @@ -246,7 +246,7 @@ ______________________ dland_file = "MET_BASE/tc_data/dland_global_tenth_degree.nc"; version = "VN.N"; -The configuration options listed above are common to many MET tools and are described in :numref:`Data IO MET Configuration File Options`. Note that TC-Gen writes output for 2x2 contingency tables to the **FHO, CTC**, and **CTS** line types. +The configuration options listed above are common to many MET tools and are described in :numref:`config_options`. Note that TC-Gen writes output for 2x2 contingency tables to the **FHO, CTC**, and **CTS** line types. tc_gen output ~~~~~~~~~~~~~ diff --git a/met/docs/Users_Guide/tc-pairs.rst b/met/docs/Users_Guide/tc-pairs.rst index 01ff0568be..3a282e8add 100644 --- a/met/docs/Users_Guide/tc-pairs.rst +++ b/met/docs/Users_Guide/tc-pairs.rst @@ -106,7 +106,7 @@ ____________________ match_points = TRUE; version = "VN.N"; -The configuration options listed above are common to multiple MET tools and are described in :numref:`Data IO MET-TC Configuration File Options`. +The configuration options listed above are common to multiple MET tools and are described in :numref:`config_options_tc`. ____________________ diff --git a/met/docs/Users_Guide/tc-rmw.rst b/met/docs/Users_Guide/tc-rmw.rst index 791213dc1b..5ef3fd002c 100644 --- a/met/docs/Users_Guide/tc-rmw.rst +++ b/met/docs/Users_Guide/tc-rmw.rst @@ -80,7 +80,7 @@ _______________________ } regrid = { ... } -The configuration options listed above are common to many MET tools and are described in :numref:`Data IO MET Configuration File Options`. The name and level entries in the data dictionary define the data to be processed. The regrid dictionary defines if and how regridding will be performed. +The configuration options listed above are common to many MET tools and are described in :numref:`config_options`. The name and level entries in the data dictionary define the data to be processed. The regrid dictionary defines if and how regridding will be performed. _______________________ diff --git a/met/docs/Users_Guide/tc-stat.rst b/met/docs/Users_Guide/tc-stat.rst index 6cecdfabbc..aad5f05f4b 100644 --- a/met/docs/Users_Guide/tc-stat.rst +++ b/met/docs/Users_Guide/tc-stat.rst @@ -114,7 +114,7 @@ An example of the tc_stat calling sequence is shown below: tc_stat -lookin /home/tc_pairs/*al092010.tcst -config TCStatConfig -In this example, the TC-Stat tool uses any TCST file (output from tc_pairs) in the listed directory for the 9th Atlantic Basin storm in 2010. Filtering options and aggregated statistics are generated following configuration options specified in the **TCStatConfig** file. Further, using flags (e.g. **-basin, -column, -storm_name,** etc...) option within the job command lines may further refine these selections. See :numref:`tc_stat-configuration-file` for options available for the job command line and :numref:`Data IO MET-TC Configuration File Options` for how to use them. +In this example, the TC-Stat tool uses any TCST file (output from tc_pairs) in the listed directory for the 9th Atlantic Basin storm in 2010. Filtering options and aggregated statistics are generated following configuration options specified in the **TCStatConfig** file. Further, using flags (e.g. **-basin, -column, -storm_name,** etc...) option within the job command lines may further refine these selections. See :numref:`tc_stat-configuration-file` for options available for the job command line and :numref:`config_options_tc` for how to use them. .. _tc_stat-configuration-file: @@ -146,7 +146,7 @@ _________________________ match_points = TRUE; version = "VN.N"; -The configuration options listed above are common to many MET tools and are described in :numref:`Data IO MET-TC Configuration File Options`. +The configuration options listed above are common to many MET tools and are described in :numref:`config_options_tc`. Note that the options specified in the first section of the configuration file, prior to the job list, will be applied to every job specified in the joblist. However, if an individual job specifies an option listed above, it will be applied to that job. For example, if model = [ **"GFSI", "LGEM", "DSHP"** ]; is set at the top, but the job in the joblist sets the -model option to "**LGEM**", that job will only run using the LGEM model data. @@ -292,7 +292,7 @@ _________________________ The **rirw** field specifies those track points for which rapid intensification (RI) or rapid weakening (RW) occurred, based on user defined RI/RW thresholds. The **track** entry specifies that RI/RW is not turned on **(NONE)**, is computed based on the bmodel only **(BDECK)**, is computed based on the amodel only **(ADECK)**, or computed when both the amodel and bmodel (the union of the two) indicate RI/RW (BOTH). If **track** is set to **ADECK, BDECK**, or **BOTH**, only tracks exhibiting rapid intensification will be retained. Rapid intensification is officially defined as when the change in the maximum wind speed over a 24-hour period is greater than or equal to 30 kts. This is the default setting, however flexibility in this definition is provided through the use of the **time, exact** and **thresh** options. The **time** field specifies the time window (HH[MMSS] format) for which the RI/RW occurred. The **exact** field specifies whether to only count RI/RW when the intensity change is over the exact time window (TRUE), which follows the official RI definition, or if the intensity threshold is met anytime during the time window (FALSE). Finally, the **thresh** field specifies the user defined intensity threshold (where ">=" indicates RI, and "<=" indicates RW). -Using the **-rirw_track, -rirw_time_adeck, -rirw_time_bdeck, -rirw_exact_adeck, -rirw_exact_bdeck, -rirw_thresh_adeck, -rirw_thresh_bdeck** options within the job command lines may further refine these selections. See :ref:`README_TC` for how to use these options. +Using the **-rirw_track, -rirw_time_adeck, -rirw_time_bdeck, -rirw_exact_adeck, -rirw_exact_bdeck, -rirw_thresh_adeck, -rirw_thresh_bdeck** options within the job command lines may further refine these selections. See :numref:`config_options_tc` for how to use these options. _________________________ @@ -342,7 +342,7 @@ _________________________ jobs = []; -The user may specify one or more analysis jobs to be performed on the TCST lines that remain after applying the filtering parameters listed above. Each entry in the joblist contains the task and additional filtering options for a single analysis to be performed. There are three types of jobs available including *filter, summary, and rirw.* Please refer to the :ref:`README_TC` for details on how to call each job. The format for an analysis job is as follows: +The user may specify one or more analysis jobs to be performed on the TCST lines that remain after applying the filtering parameters listed above. Each entry in the joblist contains the task and additional filtering options for a single analysis to be performed. There are three types of jobs available including *filter, summary, and rirw.* Please refer to :numref:`config_options` for details on how to call each job. The format for an analysis job is as follows: _________________________ diff --git a/met/docs/Users_Guide/wavelet-stat.rst b/met/docs/Users_Guide/wavelet-stat.rst index d92723d8cd..947f7fc392 100644 --- a/met/docs/Users_Guide/wavelet-stat.rst +++ b/met/docs/Users_Guide/wavelet-stat.rst @@ -224,7 +224,7 @@ _______________________ output_prefix = ""; version = "VN.N"; -The configuration options listed above are common to many MET tools and are described in :numref:`Data IO MET Configuration File Options`. +The configuration options listed above are common to many MET tools and are described in :numref:`config_options`. _______________________