From 1b26db1c960d967377832f634cb5c77bfebab313 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Tue, 25 May 2021 14:24:46 -0600 Subject: [PATCH 01/39] testing new anchoring link idea. --- met/docs/Users_Guide/config_options.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index b27e819908..aaaf3ee078 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -291,7 +291,9 @@ References: Settings common to multiple tools _________________________________ -**exit_on_warning** +.. rst:role:: exit_on_warning + +**:rst:role:`exit_on_warning`** The "exit_on_warning" entry in ConfigConstants may be set to true or false. If set to true and a MET tool encounters a warning, it will immediately exit From 5281785f7f92916ab2db33e51e12430ef9fe6109 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Tue, 25 May 2021 14:41:08 -0600 Subject: [PATCH 02/39] testing without the bold asterik --- met/docs/Users_Guide/config_options.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index aaaf3ee078..fc016ba56f 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -293,7 +293,7 @@ _________________________________ .. rst:role:: exit_on_warning -**:rst:role:`exit_on_warning`** +:rst:role:`exit_on_warning` The "exit_on_warning" entry in ConfigConstants may be set to true or false. If set to true and a MET tool encounters a warning, it will immediately exit From 72173f1e4098b10f61266a6bd622f93e10f2e99c Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Tue, 25 May 2021 14:45:42 -0600 Subject: [PATCH 03/39] tinkering with the look --- met/docs/Users_Guide/config_options.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index fc016ba56f..b31849cada 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -292,8 +292,6 @@ Settings common to multiple tools _________________________________ .. rst:role:: exit_on_warning - -:rst:role:`exit_on_warning` The "exit_on_warning" entry in ConfigConstants may be set to true or false. If set to true and a MET tool encounters a warning, it will immediately exit From 71f6db6abd0fda3d9da07eda03517eea4e400cea Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Tue, 25 May 2021 15:18:54 -0600 Subject: [PATCH 04/39] another attempt --- met/docs/Users_Guide/config_options.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index b31849cada..77cbe929cf 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -291,7 +291,9 @@ References: Settings common to multiple tools _________________________________ -.. rst:role:: exit_on_warning +.. rst:role:: + + exit_on_warning The "exit_on_warning" entry in ConfigConstants may be set to true or false. If set to true and a MET tool encounters a warning, it will immediately exit From 0ab9b5e241997be9e6815a40b8c6e5d03f1912fb Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Tue, 25 May 2021 15:23:38 -0600 Subject: [PATCH 05/39] another attempt #2 --- met/docs/Users_Guide/config_options.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 77cbe929cf..0f4c6c4aed 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -291,7 +291,7 @@ References: Settings common to multiple tools _________________________________ -.. rst:role:: +.. _exit_on_warning exit_on_warning From 4077b46febf4b37031c0d71a1bdd8187a04b28d9 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Tue, 25 May 2021 15:32:21 -0600 Subject: [PATCH 06/39] another attempt #3 --- met/docs/Users_Guide/config_options.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 0f4c6c4aed..f6a80d07d4 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -291,7 +291,7 @@ References: Settings common to multiple tools _________________________________ -.. _exit_on_warning +.. _exit_on_warning: exit_on_warning From 2dbfd57b5fed019a60115f367ab3cedcd653e85c Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Tue, 25 May 2021 15:34:20 -0600 Subject: [PATCH 07/39] another attempt #4 --- met/docs/Users_Guide/config_options.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index f6a80d07d4..253a275d90 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -293,7 +293,7 @@ _________________________________ .. _exit_on_warning: - exit_on_warning +:ref:`exit_on_warning ` The "exit_on_warning" entry in ConfigConstants may be set to true or false. If set to true and a MET tool encounters a warning, it will immediately exit From 4d92beddc8f559efebd106518e62dae7dfbc4f60 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 3 Jun 2021 14:50:41 -0600 Subject: [PATCH 08/39] making sure new anchor works as expected. --- met/docs/Users_Guide/config_options.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 253a275d90..623e208e8e 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -303,8 +303,10 @@ with bad status after writing the warning message. exit_on_warning = FALSE; -**nc_compression** - +.. _nc_compression: + +:ref:`nc_compression ` + The "nc_compression" entry in ConfigConstants defines the compression level for the NetCDF variables. Setting this option in the config file of one of the tools overrides the default value set in ConfigConstants. The From 2feff38844ee46f078cb1d680034ff04b942ca40 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 3 Jun 2021 15:19:47 -0600 Subject: [PATCH 09/39] seeing if link will save with spaces instead of dashes --- met/docs/Users_Guide/config_options.rst | 75 +++++++++++++++++-------- 1 file changed, 52 insertions(+), 23 deletions(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 623e208e8e..5602f09abf 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -326,7 +326,9 @@ writing of NetCDF files within MET significantly. nc_compression = 0; -**output_precision** +.. _output_precision: + +:ref: `output_precision ` The "output_precision" entry in ConfigConstants defines the precision (number of significant decimal places) to be written to the ASCII output @@ -337,8 +339,10 @@ override the default value set in ConfigConstants. output_precision = 5; -**tmp_dir** - +.. _tmp_dir: + +:ref: `tmp_dir ` + The "tmp_dir" entry in ConfigConstants defines the directory for the temporary files. The directory must exist and be writable. The environment variable MET_TMP_DIR overrides the default value at the configuration file. @@ -349,8 +353,10 @@ Some tools override the temporary directory by the command line argument tmp_dir = "/tmp"; -**message_type_group_map** +.. _message_type_group_map: +:ref: `message_type_group_map ` + The "message_type_group_map" entry is an array of dictionaries, each containing a "key" string and "val" string. This defines a mapping of message type group names to a comma-separated list of values. This map is @@ -368,7 +374,9 @@ which surface verification logic should be applied. { key = "ONLYSF"; val = "ADPSFC,SFCSHP"; } ]; -**message_type_map** +.. _message_type_map: + +:ref: `message_type_map ` The "message_type_map" entry is an array of dictionaries, each containing a "key" string and "val" string. This defines a mapping of input strings @@ -391,8 +399,10 @@ types. { key = "FM-97 ACARS"; val = "AIRCFT"; } ]; -**model** - +.. _model: + +:ref: `model ` + The "model" entry specifies a name for the model being verified. This name is written to the MODEL column of the ASCII output generated. If you're verifying multiple models, you should choose descriptive model names (no @@ -403,8 +413,10 @@ e.g. model = "GFS"; model = "WRF"; -**desc** - +.._desc: + +:ref: `desc ` + The "desc" entry specifies a user-specified description for each verification task. This string is written to the DESC column of the ASCII output generated. It may be set separately in each "obs.field" verification task @@ -418,8 +430,10 @@ e.g. desc = "QC_9"; desc = "NA"; -**obtype** - +.. _obtype: + +:ref: `obtype ` + The "obtype" entry specifies a name to describe the type of verifying gridded observation used. This name is written to the OBTYPE column in the ASCII output generated. If you're using multiple types of verifying observations, @@ -432,8 +446,10 @@ the configuration file obtype value is written. obtype = "ANALYS"; -**regrid** - +.. _regrid: + +:ref: `regrid ` + The "regrid" entry is a dictionary containing information about how to handle input gridded data files. The "regrid" entry specifies regridding logic using the following entries: @@ -539,7 +555,9 @@ using the following entries: censor_val = []; } -**fcst** +.. _fcst: + +:ref: `fcst ` + The "obs" entry specifies the same type of information as "fcst", but for the observation data. It will often be set to the same things as "fcst", as shown in the example below. However, when comparing forecast and @@ -1089,8 +1109,10 @@ or obs = fcst; -**climo_mean** - +.. _climo_mean: + +:ref: `climo_mean ` + The "climo_mean" dictionary specifies climatology mean data to be read by the Grid-Stat, Point-Stat, Ensemble-Stat, and Series-Analysis tools. It consists of several entires defining the climatology file names and fields to be used. @@ -1145,8 +1167,10 @@ of several entires defining the climatology file names and fields to be used. hour_interval = 6; } -**climo_stdev** - +.. _climo_stdev: + +:ref: `climo_stdev ` + The "climo_stdev" dictionary specifies climatology standard deviation data to be read by the Grid-Stat, Point-Stat, Ensemble-Stat, and Series-Analysis tools. The "climo_mean" and "climo_stdev" data define the climatological @@ -1175,8 +1199,10 @@ over the "climo_mean" setting and then updating the "file_name" entry. file_name = [ "/path/to/climatological/standard/deviation/files" ]; } -**climo_cdf** - +.. _climo_cdf: + +:ref: `climo_cdf ` + The "climo_cdf" dictionary specifies how the the climatological mean ("climo_mean") and standard deviation ("climo_stdev") data are used to evaluate model performance relative to where the observation value falls @@ -1238,8 +1264,11 @@ all pairs into a single climatological bin. write_bins = FALSE; or TRUE } -**climatology data for probability forecasts** +.. _climatology data for probability forecasts: +:ref: `climatology data for probability forecasts ` + When specifying climatology data for probability forecasts, either supply a probabilistic "climo_mean" field or non-probabilistic "climo_mean" and "climo_stdev" fields from which a normal approximation of the climatological From 2cd12cef7cc82f4292f84da20b6af8a9968e8c6f Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 3 Jun 2021 15:22:13 -0600 Subject: [PATCH 10/39] need underscores to link --- met/docs/Users_Guide/config_options.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 5602f09abf..e9f56ad9bb 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -1264,10 +1264,9 @@ all pairs into a single climatological bin. write_bins = FALSE; or TRUE } -.. _climatology data for probability forecasts: +.. _climatology_data_for_probability_forecasts: -:ref: `climatology data for probability forecasts ` +:ref: `climatology data for probability forecasts ` When specifying climatology data for probability forecasts, either supply a probabilistic "climo_mean" field or non-probabilistic "climo_mean" and From 417cc98230d43ac2c49091dc617a8fc0b9b91464 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 3 Jun 2021 15:41:30 -0600 Subject: [PATCH 11/39] is it fixed? --- met/docs/Users_Guide/config_options.rst | 28 ++++++++++++------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index e9f56ad9bb..03294caf26 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -328,7 +328,7 @@ writing of NetCDF files within MET significantly. .. _output_precision: -:ref: `output_precision ` +:ref:`output_precision ` The "output_precision" entry in ConfigConstants defines the precision (number of significant decimal places) to be written to the ASCII output @@ -341,7 +341,7 @@ override the default value set in ConfigConstants. .. _tmp_dir: -:ref: `tmp_dir ` +:ref:`tmp_dir ` The "tmp_dir" entry in ConfigConstants defines the directory for the temporary files. The directory must exist and be writable. The environment @@ -355,7 +355,7 @@ Some tools override the temporary directory by the command line argument .. _message_type_group_map: -:ref: `message_type_group_map ` +:ref:`message_type_group_map ` The "message_type_group_map" entry is an array of dictionaries, each containing a "key" string and "val" string. This defines a mapping of @@ -376,7 +376,7 @@ which surface verification logic should be applied. .. _message_type_map: -:ref: `message_type_map ` +:ref:`message_type_map ` The "message_type_map" entry is an array of dictionaries, each containing a "key" string and "val" string. This defines a mapping of input strings @@ -401,7 +401,7 @@ types. .. _model: -:ref: `model ` +:ref:`model ` The "model" entry specifies a name for the model being verified. This name is written to the MODEL column of the ASCII output generated. If you're @@ -415,7 +415,7 @@ e.g. model = "GFS"; .._desc: -:ref: `desc ` +:ref:`desc ` The "desc" entry specifies a user-specified description for each verification task. This string is written to the DESC column of the ASCII output @@ -432,7 +432,7 @@ e.g. desc = "QC_9"; .. _obtype: -:ref: `obtype ` +:ref:`obtype ` The "obtype" entry specifies a name to describe the type of verifying gridded observation used. This name is written to the OBTYPE column in the ASCII @@ -448,7 +448,7 @@ the configuration file obtype value is written. .. _regrid: -:ref: `regrid ` +:ref:`regrid ` The "regrid" entry is a dictionary containing information about how to handle input gridded data files. The "regrid" entry specifies regridding logic @@ -557,7 +557,7 @@ using the following entries: .. _fcst: -:ref: `fcst ` +:ref:`obs ` The "obs" entry specifies the same type of information as "fcst", but for the observation data. It will often be set to the same things as "fcst", @@ -1111,7 +1111,7 @@ or .. _climo_mean: -:ref: `climo_mean ` +:ref:`climo_mean ` The "climo_mean" dictionary specifies climatology mean data to be read by the Grid-Stat, Point-Stat, Ensemble-Stat, and Series-Analysis tools. It consists @@ -1169,7 +1169,7 @@ of several entires defining the climatology file names and fields to be used. .. _climo_stdev: -:ref: `climo_stdev ` +:ref:`climo_stdev ` The "climo_stdev" dictionary specifies climatology standard deviation data to be read by the Grid-Stat, Point-Stat, Ensemble-Stat, and Series-Analysis @@ -1201,7 +1201,7 @@ over the "climo_mean" setting and then updating the "file_name" entry. .. _climo_cdf: -:ref: `climo_cdf ` +:ref:`climo_cdf ` The "climo_cdf" dictionary specifies how the the climatological mean ("climo_mean") and standard deviation ("climo_stdev") data are used to @@ -1266,7 +1266,7 @@ all pairs into a single climatological bin. .. _climatology_data_for_probability_forecasts: -:ref: `climatology data for probability forecasts ` +:ref:`climatology data for probability forecasts ` When specifying climatology data for probability forecasts, either supply a probabilistic "climo_mean" field or non-probabilistic "climo_mean" and From 9edc2f5135bb59d26f2067cc0ee0dcef5d7b0643 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 3 Jun 2021 15:55:38 -0600 Subject: [PATCH 12/39] testing --- met/docs/Users_Guide/config_options.rst | 23 ----------------------- 1 file changed, 23 deletions(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 03294caf26..0d1c98eddc 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -303,29 +303,6 @@ with bad status after writing the warning message. exit_on_warning = FALSE; -.. _nc_compression: - -:ref:`nc_compression ` - -The "nc_compression" entry in ConfigConstants defines the compression level -for the NetCDF variables. Setting this option in the config file of one of -the tools overrides the default value set in ConfigConstants. The -environment variable MET_NC_COMPRESS overrides the compression level -from configuration file. The command line argument "-compress n" for some -tools overrides it. -The range is 0 to 9. - -* 0 is to disable the compression. - -* 1 to 9: Lower number is faster, higher number for smaller files. - -WARNING: Selecting a high compression level may slow down the reading and -writing of NetCDF files within MET significantly. - -.. code-block:: none - - nc_compression = 0; - .. _output_precision: :ref:`output_precision ` From a6c7e4aff3c32a33b3474d2408b081cf04e95b15 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 3 Jun 2021 16:02:09 -0600 Subject: [PATCH 13/39] testing 2 --- met/docs/Users_Guide/config_options.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 0d1c98eddc..40b9f32788 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -303,6 +303,11 @@ with bad status after writing the warning message. exit_on_warning = FALSE; +.. _nc_compression: + +:ref:`nc_compression ` + + .. _output_precision: :ref:`output_precision ` From cb47626cdc0c70bf005f7e7d9637c75cb3072548 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 3 Jun 2021 16:04:54 -0600 Subject: [PATCH 14/39] testing 4 --- met/docs/Users_Guide/config_options.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 40b9f32788..5ce779c7f5 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -306,7 +306,8 @@ with bad status after writing the warning message. .. _nc_compression: :ref:`nc_compression ` - + +test text .. _output_precision: From e25920bd186d310bdbbda39fb9815e3662f330aa Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 3 Jun 2021 16:08:49 -0600 Subject: [PATCH 15/39] testing 5 --- met/docs/Users_Guide/config_options.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 5ce779c7f5..02331ed2e6 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -307,8 +307,14 @@ with bad status after writing the warning message. :ref:`nc_compression ` -test text - +The "nc_compression" entry in ConfigConstants defines the compression level +for the NetCDF variables. Setting this option in the config file of one of +the tools overrides the default value set in ConfigConstants. The +environment variable MET_NC_COMPRESS overrides the compression level +from configuration file. The command line argument "-compress n" for some +tools overrides it. +The range is 0 to 9. + .. _output_precision: :ref:`output_precision ` From a3ac970418a67fe0ddba6ab70284f3f659f3af6a Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 3 Jun 2021 16:13:11 -0600 Subject: [PATCH 16/39] testing 6 --- met/docs/Users_Guide/config_options.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 02331ed2e6..82a62b9833 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -315,6 +315,10 @@ from configuration file. The command line argument "-compress n" for some tools overrides it. The range is 0 to 9. +* 0 is to disable the compression. + +* 1 to 9: Lower number is faster, higher number for smaller files. + .. _output_precision: :ref:`output_precision ` From 655ef7510b447456fbabbc6be9c30c1e2f683f68 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 3 Jun 2021 16:15:55 -0600 Subject: [PATCH 17/39] testing 7 --- met/docs/Users_Guide/config_options.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 82a62b9833..9444217556 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -319,6 +319,9 @@ The range is 0 to 9. * 1 to 9: Lower number is faster, higher number for smaller files. +WARNING: Selecting a high compression level may slow down the reading and +writing of NetCDF files within MET significantly. + .. _output_precision: :ref:`output_precision ` From 0b4b4f351e668de18356fea1290e8678f6c1e660 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 3 Jun 2021 16:20:49 -0600 Subject: [PATCH 18/39] testing 8 --- met/docs/Users_Guide/config_options.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 9444217556..e1b8a1375e 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -322,6 +322,10 @@ The range is 0 to 9. WARNING: Selecting a high compression level may slow down the reading and writing of NetCDF files within MET significantly. +.. code-block:: none + + nc_compression = 0; + .. _output_precision: :ref:`output_precision ` From 5efe7c13606f76e1cfd5f1b0b4fa8b680c892c3b Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 3 Jun 2021 16:30:38 -0600 Subject: [PATCH 19/39] going back to test original problem --- met/docs/Users_Guide/config_options.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index e1b8a1375e..214def01dc 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -1264,9 +1264,9 @@ all pairs into a single climatological bin. write_bins = FALSE; or TRUE } -.. _climatology_data_for_probability_forecasts: +.. _climatology data for probability forecasts: -:ref:`climatology data for probability forecasts ` +:ref:`climatology data for probability forecasts ` When specifying climatology data for probability forecasts, either supply a probabilistic "climo_mean" field or non-probabilistic "climo_mean" and From adffc9a24fd25e1986cda7b81e8ccc05d9e0903a Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 3 Jun 2021 16:33:44 -0600 Subject: [PATCH 20/39] able to link with spaces instead of underscores. Testing if a return is possible to keep under 79 character limit. --- met/docs/Users_Guide/config_options.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 214def01dc..b2b047ca44 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -1266,7 +1266,8 @@ all pairs into a single climatological bin. .. _climatology data for probability forecasts: -:ref:`climatology data for probability forecasts ` +:ref:`climatology data for probability forecasts ` When specifying climatology data for probability forecasts, either supply a probabilistic "climo_mean" field or non-probabilistic "climo_mean" and From 4a1fdfa3c0735ed7daa6a2dc89d549dbf0d1d2c9 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 3 Jun 2021 16:36:52 -0600 Subject: [PATCH 21/39] double checking everything is still working. --- met/docs/Users_Guide/config_options.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index b2b047ca44..d84a7f1032 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -1283,7 +1283,9 @@ the MET tools use the mean, standard deviation, and observation event threshold to derive a normal approximation of the climatological probabilities. Those derived probability values are used to compute BSS. -**mask_missing_flag** +.. _mask_missing_flag: + +:ref:`mask_missing_flag ` The "mask_missing_flag" entry specifies how missing data should be handled in the Wavelet-Stat and MODE tools: From 2716a06f6cc7f305b3ff6f152bfbeaeb9efd9473 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 3 Jun 2021 16:42:32 -0600 Subject: [PATCH 22/39] DO NOT break ref lines apart, it won't work. --- met/docs/Users_Guide/config_options.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index d84a7f1032..97b6d4d1a7 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -1266,8 +1266,7 @@ all pairs into a single climatological bin. .. _climatology data for probability forecasts: -:ref:`climatology data for probability forecasts ` +:ref:`climatology data for probability forecasts ` When specifying climatology data for probability forecasts, either supply a probabilistic "climo_mean" field or non-probabilistic "climo_mean" and From 5bb72409144e1c9825633fef78f05572b26d0f4a Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 3 Jun 2021 16:47:05 -0600 Subject: [PATCH 23/39] trying a shorter name. --- met/docs/Users_Guide/config_options.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 97b6d4d1a7..5455955bc9 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -1264,9 +1264,9 @@ all pairs into a single climatological bin. write_bins = FALSE; or TRUE } -.. _climatology data for probability forecasts: +.. _climato_data: -:ref:`climatology data for probability forecasts ` +:ref:`climatology data for probability forecasts ` When specifying climatology data for probability forecasts, either supply a probabilistic "climo_mean" field or non-probabilistic "climo_mean" and From b54d9484b61de93e472ae35f19142eeee3402a2c Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Thu, 3 Jun 2021 17:12:32 -0600 Subject: [PATCH 24/39] continuing to add anchors --- met/docs/Users_Guide/config_options.rst | 64 ++++++++++++++++++------- 1 file changed, 46 insertions(+), 18 deletions(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 5455955bc9..53f0f0e426 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -1302,7 +1302,9 @@ in the Wavelet-Stat and MODE tools: mask_missing_flag = BOTH; -**obs_window** +.. _obs_window: + +:ref:`obs_window ` The "obs_window" entry is a dictionary specifying a beginning ("beg" entry) and ending ("end" entry) time offset values in seconds. It defines @@ -1318,8 +1320,10 @@ Point-Stat and Ensemble-Stat, the reference time is the forecast valid time. end = 5400; } -**mask** +.. _mask: +:ref:`mask ` + The "mask" entry is a dictionary that specifies the verification masking regions to be used when computing statistics. Each mask defines a geographic extent, and any matched pairs falling inside that area will be @@ -1428,7 +1432,9 @@ is included in the mask. } -**ci_alpha** +.. _ci_alpha: + +:ref:`ci_alpha ` The "ci_alpha" entry is an array of floats specifying the values for alpha to be used when computing confidence intervals. Values of alpha must be @@ -1440,7 +1446,9 @@ interval. ci_alpha = [ 0.05, 0.10 ]; -**boot** +.. _boot: + +:ref:`boot ` The "boot" entry defines the parameters to be used in calculation of bootstrap confidence intervals. The interval variable indicates what method @@ -1502,7 +1510,9 @@ should be used for computing bootstrap confidence intervals: seed = ""; } -**interp** +.. _interp: + +:ref:`interp ` The "interp" entry is a dictionary that specifies what interpolation or smoothing (for the Grid-Stat tool) methods should be applied. @@ -1605,8 +1615,10 @@ This dictionary may include the following entries: ]; } -**nbrhd** - +.. _nbrhd: + +:ref:`nbrhd ` + The "nbrhd" entry is a dictionary that is very similar to the "interp" entry. It specifies information for computing neighborhood statistics in Grid-Stat. This dictionary may include the following entries: @@ -1650,8 +1662,10 @@ Grid-Stat. This dictionary may include the following entries: cov_thresh = [ >=0.5 ]; } -**fourier** +.. _fourier: +:ref:`fourier ` + The "fourier" entry is a dictionary which specifies the application of the Fourier decomposition method. It consists of two arrays of the same length which define the beginning and ending wave numbers to be included. If the @@ -1681,7 +1695,9 @@ of the verification grid: wave_1d_end = [ 3, 9, 20 ]; } -**gradient** +.. _gradient: + +:ref:`gradient ` The "gradient" entry is a dictionary which specifies the number and size of gradients to be computed. The "dx" and "dy" entries specify the size of the @@ -1701,8 +1717,10 @@ This configuration option may be set separately in each "obs.field" entry. dy = [ 1 ]; } -**distance_map** - +.. _distance_map: + +:ref:`distance_map ` + The "distance_map" entry is a dictionary containing options related to the distance map statistics in the DMAP output line type. The "baddeley_p" entry is an integer specifying the exponent used in the Lp-norm when computing the @@ -1727,8 +1745,10 @@ This configuration option may be set separately in each "obs.field" entry. zhu_weight = 0.5; } -**land_mask** - +.. _land_mask: + +:ref:`land_mask ` + The "land_mask" dictionary defines the land/sea mask field which is used when verifying at the surface. For point observations whose message type appears in the "LANDSF" entry of the "message_type_group_map" setting, @@ -1754,8 +1774,10 @@ land_mask.flag may be set separately in each "obs.field" entry. thresh = eq1; } -**topo_mask** - +.. _topo_mask: + +:ref:`topo_mask ` + The "topo_mask" dictionary defines the model topography field which is used when verifying at the surface. This logic is applied to point observations whose message type appears in the "SURFACE" entry of the @@ -1783,8 +1805,10 @@ topo_mask.flag may be set separately in each "obs.field" entry. interp_fcst_thresh = ge-50&&le50; } -**hira** +.. _hira: +:ref:`hira ` + The "hira" entry is a dictionary that is very similar to the "interp" and "nbrhd" entries. It specifies information for applying the High Resolution Assessment (HiRA) verification logic in Point-Stat. HiRA is analogous to @@ -1835,8 +1859,10 @@ This dictionary may include the following entries: prob_cat_thresh = []; } -**output_flag** +.. _output_flag: +:ref:`output_flag ` + The "output_flag" entry is a dictionary that specifies what verification methods should be applied to the input data. Options exist for each output line type from the MET tools. Each line type may be set to one of: @@ -1885,7 +1911,9 @@ output line type from the MET tools. Each line type may be set to one of: grad = NONE; Gradient statistics (S1 score) } -**nc_pairs_flag** +.. _nc_pairs_flag: + +:ref:`nc_pairs_flag ` The "nc_pairs_flag" can be set either to a boolean value or a dictionary in either Grid-Stat, Wavelet-Stat or MODE. The dictionary (with slightly From 1d9278f2019e0ff83a33ec1a44f0e464b1660cc7 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Fri, 4 Jun 2021 10:30:15 -0600 Subject: [PATCH 25/39] updating lines 1946 thru 2214 with anchors --- met/docs/Users_Guide/config_options.rst | 70 ++++++++++++++++++------- 1 file changed, 50 insertions(+), 20 deletions(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 53f0f0e426..89362a687e 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -1943,7 +1943,9 @@ netcdf output will be generated. apply_mask = TRUE; } -**nc_pairs_var_name** +.. _nc_pairs_var_name: + +:ref:`nc_pairs_var_name ` The "nc_pairs_var_name" entry specifies a string for each verification task in Grid-Stat. This string is parsed from each "obs.field" dictionary entry @@ -1962,8 +1964,10 @@ For example: nc_pairs_var_name = ""; -**nc_pairs_var_suffix** - +.. _nc_pairs_var_suffix: + +:ref:`nc_pairs_var_suffix ` + The "nc_pairs_var_suffix" entry is similar to the "nc_pairs_var_name" entry described above. It is also parsed from each "obs.field" dictionary entry. However, it defines a suffix to be appended to the output variable name. @@ -1984,8 +1988,10 @@ now deprecated. nc_pairs_var_suffix = ""; -**ps_plot_flag** - +.. _ps_plot_flag: + +:ref:`ps_plot_flag ` + The "ps_plot_flag" entry is a boolean value for Wavelet-Stat and MODE indicating whether a PostScript plot should be generated summarizing the verification. @@ -1994,8 +2000,10 @@ the verification. ps_plot_flag = TRUE; -**grid_weight_flag** +.. _grid_weight_flag: +:ref:`grid_weight_flag ` + The "grid_weight_flag" specifies how grid weighting should be applied during the computation of continuous statistics and partial sums. It is meant to account for grid box area distortion and is often applied to global @@ -2017,7 +2025,9 @@ by the sum of the weights for the current masking region. grid_weight_flag = NONE; -**rank_corr_flag** +.. _rank_corr_flag: + +ref:`rank_corr_flag ` The "rank_corr_flag" entry is a boolean to indicate whether Kendall's Tau and Spearman's Rank Correlation Coefficients (in the CNT line type) should @@ -2028,7 +2038,9 @@ intensive and slows down the runtime significantly. rank_corr_flag = FALSE; -**duplicate_flag** +.. _duplicate_flag: + +:ref:`duplicate_flag ` The "duplicate_flag" entry specifies how to handle duplicate point observations in Point-Stat and Ensemble-Stat: @@ -2049,7 +2061,9 @@ in those cases. duplicate_flag = NONE; -**obs_summary** +.. _obs_summary: + +:ref:`obs_summary ` The "obs_summary" entry specifies how to compute statistics on observations that appear at a single location (lat,lon,level,elev) @@ -2084,8 +2098,10 @@ in those cases. obs_summary = NONE; -**obs_perc_value** +.. _obs_perc_value: +:ref:`*obs_perc_value <*obs_perc_value>` + Percentile value to use when obs_summary = PERC .. code-block:: none @@ -2093,7 +2109,9 @@ Percentile value to use when obs_summary = PERC obs_perc_value = 50; -**obs_quality** +.. _obs_quality: + +:ref:`obs_quality ` The "obs_quality" entry specifies the quality flag values that are to be retained and used for verification. An empty list signifies that all @@ -2107,7 +2125,9 @@ an array of strings, even if the values themselves are numeric. obs_quality = [ "1", "2", "3", "9" ]; -**met_data_dir** +.. _met_data_dir: + +:ref:`met_data_dir ` The "met_data_dir" entry specifies the location of the internal MET data sub-directory which contains data files used when generating plots. It @@ -2118,8 +2138,10 @@ locate the static data files they need at run time. met_data_dir = "MET_BASE"; -**fcst_raw_plot, obs_raw_plot, wvlt_plot, object_plot** - +.. _many_plots: + +:ref:`fcst_raw_plot, obs_raw_plot, wvlt_plot, object_plot ` + The "fcst_raw_plot" entry is a dictionary used by Wavelet-Stat and MODE containing colortable plotting information for the plotting of the raw forecast field: @@ -2149,7 +2171,9 @@ forecast field: The "obs_raw_plot", "wvlt_plot", and "object_plot" entries are dictionaries similar to the "fcst_raw_plot" described above. -**tmp_dir** +.. _tmp_dir: + +:ref:`tmp_dir ` The "tmp_dir" entry is a string specifying the location where temporary files should be written. @@ -2159,7 +2183,9 @@ files should be written. tmp_dir = "/tmp"; -**output_prefix** +.. _output_prefix: + +:ref:`output_prefix ` The "output_prefix" entry specifies a string to be included in the output file name. The MET statistics tools construct output file names that @@ -2171,8 +2197,10 @@ of the same tool. output_prefix = ""; -**version** - +.. _version: + +:ref:`version ` + The "version" entry specifies the version number of the configuration file. The configuration file version number should match the version number of the MET code being run. This value should generally not be modified. @@ -2181,8 +2209,10 @@ the MET code being run. This value should generally not be modified. version = "VN.N"; -**time_summary** - +.. _time_summary: + +:ref:`time_summary ` + This feature was implemented to allow additional processing of observations with high temporal resolution. The "flag" entry toggles the "time_summary" on (TRUE) and off (FALSE). Obs may be summarized across the user specified From 612fb3de06f42e94750b09b75b55638c0324a55a Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Fri, 4 Jun 2021 11:04:59 -0600 Subject: [PATCH 26/39] updating lines 2214 thru 3371 with anchors --- met/docs/Users_Guide/config_options.rst | 122 +++++++++++++++++------- 1 file changed, 88 insertions(+), 34 deletions(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 89362a687e..4f44c71298 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -2288,7 +2288,9 @@ _____________________________________ EnsembleStatConfig_default ~~~~~~~~~~~~~~~~~~~~~~~~~~ -**ens** +.. _ens: + +:ref:`ens ` The "ens" entry is a dictionary that specifies the fields for which ensemble products should be generated. This is very similar to the "fcst" and "obs" @@ -2330,8 +2332,10 @@ entries. This dictionary may include the following entries: ]; } -**nbrhd_prob** - +.. _nbrhd_prob: + +:ref:`nbrhd_prob ` + The nbrhd_prob dictionary defines the neighborhoods used to compute NEP and NMEP output. The neighborhood shape is a SQUARE or CIRCLE centered on the current point, and the width array specifies the width of the square or @@ -2351,7 +2355,9 @@ specified. vld_thresh = 0.0; } -**nmep_smooth** +.. _nmep_smooth: + +:ref:`nmep_smooth ` Similar to the interp dictionary, the nmep_smooth dictionary includes a type array of dictionaries to define one or more methods for smoothing the NMEP @@ -2377,7 +2383,9 @@ combination of the categorical threshold (cat_thresh), neighborhood width ]; } -**fcst, obs** +.. _fcst, obs: + +:ref:`fcst, obs ` The fcst and obs entries define the fields for which Ensemble-Stat should compute rank histograms, probability integral transform histograms, @@ -2415,8 +2423,10 @@ data is provided, the climo_cdf thresholds will be used instead. } -**nc_var_str** - +.. _nc_var_str: + +:ref:`nc_var_str ` + The "nc_var_str" entry specifies a string for each ensemble field and verification task in Ensemble-Stat. This string is parsed from each "ens.field" and "obs.field" dictionary entry and is used to customize @@ -2431,7 +2441,9 @@ e.g. nc_var_str = "MIN"; nc_var_str = ""; -**obs_thresh** +.. _obs_thresh: + +:ref:`obs_thresh ` The "obs_thresh" entry is an array of thresholds for filtering observation values prior to applying ensemble verification logic. They specify the values @@ -2444,7 +2456,9 @@ This option may be set separately for each obs.field entry. obs_thresh = [ NA ]; -**skip_const** +.. _skip_const: + +:ref:`skip_const ` Setting "skip_const" to true tells Ensemble-Stat to exclude pairs where all the ensemble members and the observation have a constant value. For example, @@ -2457,7 +2471,9 @@ random. skip_const = FALSE; -**obs_error** +.. _obs_error: + +:ref:`obs_error ` Observation error options @@ -2514,7 +2530,9 @@ levels, and range of values. max = NA; } -**ensemble_flag** +.. _ensemble_flag: + +:ref:`ensemble_flag ` The "ensemble_flag" entry is a dictionary of boolean value indicating which ensemble products should be generated: @@ -2565,7 +2583,9 @@ which ensemble products should be generated: weight = FALSE; } -**rng** +.. _rng: + +:ref:`rng ` See: `Random Number Generator Performance `_ used for random assignment of ranks when they are tied. @@ -2918,7 +2938,9 @@ MET User's Guide for a description of these attributes. MODEConfig_default ~~~~~~~~~~~~~~~~~~ -**quilt** +.. _quilt: + +:ref:`quilt ` The "quilt" entry is a boolean to indicate whether all permutations of convolution radii and thresholds should be run. If set to false, the number @@ -2933,7 +2955,9 @@ MODE will be run. quilt = false; -**fcst, obs** +.. _fcst, obs: + +:ref:`fcst, obs ` The object definition settings for MODE are contained within the "fcst" and "obs" entries: @@ -3017,7 +3041,9 @@ The object definition settings for MODE are contained within the "fcst" and merge_flag = THRESH; } -**grid_res** +.. _grid_res: + +:ref:`grid_res ` The "grid_res" entry is the nominal spacing for each grid square in kilometers. The variable is not used directly in the code, but subsequent @@ -3029,7 +3055,9 @@ are used for these variables. grid_res = 4; -**match_flag** +.. _match_flag: + +:ref:`match_flag ` The "match_flag" entry specifies the matching method to be applied: @@ -3047,8 +3075,10 @@ The "match_flag" entry specifies the matching method to be applied: match_flag = MERGE_BOTH; -**max_centroid_dist** - +.. _max_centroid_dist: + +:ref:`max_centroid_dist ` + The "max_centroid_dist" entry specifies the maximum allowable distance in grid squares between the centroids of objects for them to be compared. Setting this to a reasonable value speeds up the runtime enabling MODE to @@ -3058,8 +3088,10 @@ skip unreasonable object comparisons. max_centroid_dist = 800.0/grid_res; -**weight** - +.. _weight: + +:ref:`weight ` + The weight variables control how much weight is assigned to each pairwise attribute when computing a total interest value for object pairs. The weights need not sum to any particular value but must be non-negative. When the @@ -3080,7 +3112,9 @@ sum of the weights listed. inten_perc_value = 50; } -**interest_function** +.. _interest_function: + +:ref:`interest_function ` The set of interest function variables listed define which values are of interest for each pairwise attribute measured. The interest functions may be @@ -3136,7 +3170,9 @@ mathematical functions. inten_perc_ratio = ratio_if; } -**total_interest_thresh** +.. _total_interest_thresh: + +:ref:`total_interest_thresh ` The total_interest_thresh variable should be set between 0 and 1. This threshold is applied to the total interest values computed for each pair of @@ -3146,8 +3182,10 @@ objects and is used in determining matches. total_interest_thresh = 0.7; -**print_interest_thresh** - +.. _print_interest_thresh: + +:ref:`print_interest_thresh ` + The print_interest_thresh variable determines which pairs of object attributes will be written to the output object attribute ASCII file. The user may choose to set the print_interest_thresh to the same value as the @@ -3160,7 +3198,9 @@ the max_centroid_dist variable. print_interest_thresh = 0.0; -**plot_valid_flag** +.. _plot_valid_flag: + +:ref:`plot_valid_flag ` When applied, the plot_valid_flag variable indicates that only the region containing valid data after masking is applied should be plotted. TRUE @@ -3171,7 +3211,9 @@ region containing valid data after masking should be plotted. plot_valid_flag = FALSE; -**plot_gcarc_flag** +.. _plot_gcarc_flag: + +:ref:`plot_gcarc_flag ` When applied, the plot_gcarc_flag variable indicates that the edges of polylines should be plotted using great circle arcs as opposed to straight @@ -3181,7 +3223,9 @@ lines in the grid. plot_gcarc_flag = FALSE; -**ct_stats_flag** +.. _ct_stats_flag: + +:ref:`ct_stats_flag ` The ct_stats_flag can be set to TRUE or FALSE to produce additional output, in the form of contingency table counts and statistics. @@ -3190,8 +3234,10 @@ in the form of contingency table counts and statistics. ct_stats_flag = TRUE; -**shift_right** - +.. _shift_right: + +:ref:`shift_right ` + When MODE is run on global grids, this parameter specifies how many grid squares to shift the grid to the right. MODE does not currently connect objects from one side of a global grid to the other, potentially causing @@ -3265,7 +3311,9 @@ following criteria: 7 - Auxiliary levels generated via interpolation from spanning levels (upper-air profile reports) -**message_type** +.. _message_type: + +:ref:`message_type ` In the PB2NC tool, the "message_type" entry is an array of message types to be retained. An empty list indicates that all should be retained. @@ -3286,7 +3334,9 @@ For example: message_type = []; -**message_type_group_map** +.. _message_type_group_map: + +:ref:`message_type_group_map ` Mapping of message type group name to comma-separated list of values. The default setting defines ANYAIR, ANYSFC, and ONLYSF as groups. @@ -3301,8 +3351,10 @@ Derive PRMSL only for SURFACE message types. { key = "ONLYSF"; val = "ADPSFC,SFCSHP"; } ]; -**station_id** - +.. _station_id: + +:ref:`station_id ` + The "station_id" entry is an array of station ids to be retained or the filename which contains station ids. An array of station ids contains a comma-separated list. An empty list indicates that all @@ -3314,7 +3366,9 @@ For example: station_id = [ "KDEN" ]; station_id = []; -**elevation_range** +.. _elevation_range: + +:ref:`elevation_range ` The "elevation_range" entry is a dictionary which contains "beg" and "end" entries specifying the range of observing locations elevations to be From 6c07e3d6c2a13805d24038840d2e5654d16231da Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Fri, 4 Jun 2021 11:45:57 -0600 Subject: [PATCH 27/39] updating lines 3371 to the end with anchors --- met/docs/Users_Guide/config_options.rst | 122 ++++++++++++++++-------- 1 file changed, 84 insertions(+), 38 deletions(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 4f44c71298..df9e14f434 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -3381,8 +3381,10 @@ retained. end = 100000; } -**pb_report_type** - +.. _pb_report_type: + +:ref:`pb_report_type ` + The "pb_report_type" entry is an array of PREPBUFR report types to be retained. The numeric "pb_report_type" entry allows for further stratification within message types. An empty list indicates that all should @@ -3401,8 +3403,10 @@ For example: pb_report_type = []; -**in_report_type** - +.. _in_report_type: + +:ref:`in_report_type ` + The "in_report_type" entry is an array of input report type values to be retained. The numeric "in_report_type" entry provides additional stratification of observations. An empty list indicates that all should @@ -3420,7 +3424,9 @@ For example: in_report_type = []; -**instrument_type** +.. _instrument_type: + +:ref:`instrument_type ` The "instrument_type" entry is an array of instrument types to be retained. An empty list indicates that all should be retained. @@ -3429,8 +3435,10 @@ An empty list indicates that all should be retained. instrument_type = []; -**level_range** - +.. _level_range: + +:ref:`level_range ` + The "level_range" entry is a dictionary which contains "beg" and "end" entries specifying the range of vertical levels (1 to 255) to be retained. @@ -3441,8 +3449,10 @@ entries specifying the range of vertical levels (1 to 255) to be retained. end = 255; } -**level_category** - +.. _level_category: + +:ref:`level_category ` + The "level_category" entry is an array of integers specifying which level categories should be retained: @@ -3477,7 +3487,9 @@ See: `Current Table A Entries in PREPBUFR mnemonic table ` The "obs_bufr_var" entry is an array of strings containing BUFR variable names to be retained or derived. This replaces the "obs_grib_code" setting @@ -3497,7 +3509,9 @@ command line option to see the list of available observation variables. obs_bufr_var = [ "QOB", "TOB", "ZOB", "UOB", "VOB" ]; -**obs_bufr_map** +.. _obs_bufr_map: + +:ref:`obs_bufr_map ` Mapping of input BUFR variable names to output variables names. The default PREPBUFR map, obs_prepbufr_map, is appended to this map. @@ -3508,8 +3522,10 @@ of the forecast the observation is used to verify. obs_bufr_map = []; -**obs_prefbufr_map** - +.. _obs_prefbufr_map: + +:ref:`obs_prefbufr_map ` + Default mapping for PREPBUFR. Replace input BUFR variable names with GRIB abbreviations in the output. This default map is appended to obs_bufr_map. This should not typically be overridden. This default mapping provides @@ -3533,8 +3549,10 @@ abbreviations to the output. { key = "D_PRMSL"; val = "PRMSL"; } ]; -**quality_mark_thresh** - +.. _quality_mark_thresh: + +:ref:`quality_mark_thresh ` + The "quality_mark_thresh" entry specifies the maximum quality mark value to be retained. Observations with a quality mark LESS THAN OR EQUAL TO this threshold will be retained, while observations with a quality mark @@ -3546,8 +3564,10 @@ See `Code table for observation quality markers ` + The "event_stack_flag" entry is set to "TOP" or "BOTTOM" to specify whether observations should be drawn from the top of the event stack (most quality controlled) or the bottom of the event stack (most raw). @@ -3559,7 +3579,9 @@ stack (most quality controlled) or the bottom of the event stack (most raw). SeriesAnalysisConfig_default ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -**block_size** +.. _block_size: + +:ref:`block_size ` Computation may be memory intensive, especially for large grids. The "block_size" entry sets the number of grid points to be processed @@ -3570,8 +3592,10 @@ require less memory but increase the number of passes through the data. block_size = 1024; -**vld_thresh** - +.. _vld_thresh: + +:ref:`vld_thresh ` + Ratio of valid matched pairs to total length of series for a grid point. If valid threshold is exceeded at that grid point the statistics are computed and stored. If not, a bad data flag is stored. The default @@ -3582,8 +3606,10 @@ setting requires all data in the series to be valid. vld_thresh = 1.0; -**output_stats** - +.. _output_stats: + +:ref:`output_stats ` + Statistical output types need to be specified explicitly. Refer to User's Guide for available output types. To keep output file size reasonable, it is recommended to process a few output types at a time, especially if the @@ -3608,7 +3634,9 @@ grid is large. STATAnalysisConfig_default ~~~~~~~~~~~~~~~~~~~~~~~~~~ -**jobs** +.. _jobs: + +:ref:`jobs ` The "jobs" entry is an array of STAT-Analysis jobs to be performed. Each element in the array contains the specifications for a single analysis @@ -4074,7 +4102,9 @@ confidence intervals computed for the aggregated statistics. WaveletStatConfig_default ~~~~~~~~~~~~~~~~~~~~~~~~~ -**grid_decomp_flag** +.. _grid_decomp_flag: + +:ref:`grid_decomp_flag ` The "grid_decomp_flag" entry specifies how the grid should be decomposed in Wavelet-Stat into dyadic (2^n x 2^n) tiles: @@ -4089,8 +4119,10 @@ Wavelet-Stat into dyadic (2^n x 2^n) tiles: grid_decomp_flag = AUTO; -**tile** - +.. _tile: + +:ref:`tile ` + The "tile" entry is a dictionary that specifies how tiles should be defined in Wavelet-Stat when the "grid_decomp_flag" is set to "TILE": @@ -4113,8 +4145,10 @@ in Wavelet-Stat when the "grid_decomp_flag" is set to "TILE": ]; } -**wavelet** - +.. _wavelet: + +:ref:`wavelet ` + The "wavelet" entry is a dictionary in Wavelet-Stat that specifies how the wavelet decomposition should be performed: @@ -4148,8 +4182,10 @@ wavelet decomposition should be performed: member = 2; } -**obs_raw_plot, wvlt_plot, object_plot** - +.. _obs_raw_wvlt_object_plots: + +:ref:`obs_raw_plot, wvlt_plot, object_plot ` + The "obs_raw_plot", "wvlt_plot", and "object_plot" entries are dictionaries similar to the "fcst_raw_plot" described in the "Settings common to multiple tools" section. @@ -4157,12 +4193,16 @@ tools" section. WWMCARegridConfig_default ~~~~~~~~~~~~~~~~~~~~~~~~~ -**to_grid** +.. _to_grid: + +:ref:`to_grid ` Please see the description of the "to_grid" entry in the "regrid" dictionary above. -**NetCDF output information** - +.. _NetCDF output information: + +:ref:`NetCDF output information ` + Supply the NetCDF output information. For example: .. code-block:: none @@ -4179,15 +4219,19 @@ Supply the NetCDF output information. For example: long_name = ""; level = ""; -**max_minutes (pixel age)** - +.. _max_minutes (pixel age): + +:ref:`max_minutes (pixel age) ` + Maximum pixel age in minutes .. code-block:: none max_minutes = 120; -**swap_endian** +.. _swap_endian: + +:ref:`swap_endian ` The WWMCA pixel age data is stored in binary data files in 4-byte blocks. The swap_endian option indicates whether the endian-ness of the data should @@ -4197,8 +4241,10 @@ be swapped after reading. swap_endian = TRUE; -**write_pixel_age** - +.. _write_pixel_age: + +:ref:`write_pixel_age ` + By default, wwmca_regrid writes the cloud percent data specified on the command line to the output file. This option writes the pixel age data, in minutes, to the output file instead. From 1e0b1c3005259dcb7b1c051df3e4336ebcbceb78 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Fri, 4 Jun 2021 13:10:22 -0600 Subject: [PATCH 28/39] testing anchor --- met/docs/Users_Guide/config_options_tc.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/met/docs/Users_Guide/config_options_tc.rst b/met/docs/Users_Guide/config_options_tc.rst index 11f7330b4b..c6929324c2 100644 --- a/met/docs/Users_Guide/config_options_tc.rst +++ b/met/docs/Users_Guide/config_options_tc.rst @@ -8,7 +8,9 @@ See :numref:`config_options` for a description of the configuration file syntax. Configuration settings common to multiple tools _______________________________________________ -**storm_id** +.. _storm_id: + +:ref:`storm_id ` Specify a comma-separated list of storm id's to be used: From 51c0a1ecf0327e6d795c5e4bb7c27dc3a5c74e21 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Fri, 4 Jun 2021 13:30:21 -0600 Subject: [PATCH 29/39] testing anchor --- met/docs/Users_Guide/config_options_tc.rst | 72 +++++++++++++++------- 1 file changed, 51 insertions(+), 21 deletions(-) diff --git a/met/docs/Users_Guide/config_options_tc.rst b/met/docs/Users_Guide/config_options_tc.rst index c6929324c2..f9f496933c 100644 --- a/met/docs/Users_Guide/config_options_tc.rst +++ b/met/docs/Users_Guide/config_options_tc.rst @@ -30,7 +30,9 @@ This may also be set using basin, cyclone, and timing information below. storm_id = []; -**basin** +.. _basin: + +:ref:`basin ` Specify a comma-separated list of basins to be used. Expected format is a 2-letter basin identifier. An empty list indicates that all should be used. @@ -48,8 +50,10 @@ For example: basin = []; -**cyclone** - +.. _cyclone: + +:ref:`cyclone ` + Specify a comma-separated list of cyclone numbers (01-99) to be used. An empty list indicates that all should be used. @@ -62,7 +66,9 @@ For example: cyclone = []; -**storm_name** +.. _storm_name: + +:ref:`storm_name ` Specify a comma-separated list of storm names to be used. An empty list indicates that all should be used. @@ -76,7 +82,9 @@ For example: storm_name = []; -**init_beg, init_end, init_inc, init_exc** +.. _init_beg end inc exc: + +:ref:`init_beg, init_end, init_inc, init_exc ` Specify a model initialization time window in YYYYMMDD[_HH[MMSS]] format or provide a list of specific initialization times to include (inc) @@ -100,8 +108,10 @@ For example: init_exc = []; -**valid_beg, valid_end** - +.. _valid_beg, valid_end: + +:ref:`valid_beg, valid_end ` + Specify a model valid time window in YYYYMMDD[_HH[MMSS]] format. Tracks for which all valid times fall within the time window will be used. An empty string indicates that all times should be used. @@ -118,7 +128,9 @@ For example: valid_beg = ""; valid_end = ""; -**init_hour** +.. _init_hour: + +:ref:`init_hour ` Specify a comma-separated list of model initialization hours to be used in HH[MMSS] format. An empty list indicates that all hours should be used. @@ -132,7 +144,9 @@ For example: init_hour = []; -**lead_req** +.. _lead_req: + +:ref:`lead_req ` Specify the required lead time in HH[MMSS] format. Tracks that contain all of these required times will be @@ -145,7 +159,9 @@ all lead times will be used. lead_req = []; -**init_mask, valid_mask** +.. _init_mask, valid_mask: + +:ref:`init_mask, valid_mask ` Specify lat/lon polylines defining masking regions to be applied. Tracks whose initial location falls within init_mask will be used. @@ -161,7 +177,9 @@ For example: init_mask = ""; valid_mask = ""; -**version** +.. _version: + +:ref:`version ` Indicate the version number for the contents of this configuration file. The value should generally not be modified. @@ -178,7 +196,9 @@ _____________________________________ TCPairsConfig_default ~~~~~~~~~~~~~~~~~~~~~ -**model** +.. _model: + +:reff:`model ` The "model" entry specifies an array of model names to be verified. If verifying multiple models, choose descriptive model names (no whitespace) @@ -193,8 +213,9 @@ For example: model = []; +.. _check_dup: -**check_dup** +:ref:`check_dup ` Specify whether the code should check for duplicate ATCF lines when building tracks. Setting this to FALSE makes the parsing of tracks quicker. @@ -208,8 +229,10 @@ For example: check_dup = FALSE; -**interp12** - +interp12: + +:ref:`interp12 ` + Specify whether special processing should be performed for interpolated model names ending in 'I' (e.g. AHWI). Search for corresponding tracks whose model name ends in '2' (e.g. AHW2) and apply the following logic: @@ -226,8 +249,10 @@ name ends in '2' (e.g. AHW2) and apply the following logic: interp12 = REPLACE; -**consensus** - +.. _consensus: + +:ref:`consensus ` + Specify how consensus forecasts should be defined: | name = consensus model name @@ -253,8 +278,10 @@ For example: consensus = []; -**lag_time** - +.. _lag_time: + +:ref:`lag_time ` + Specify a comma-separated list of forecast lag times to be used in HH[MMSS] format. For each ADECK track identified, a lagged track will be derived for each entry listed. @@ -269,8 +296,11 @@ For example: lag_time = []; -**best_technique, best_baseline, oper_technique, oper_baseline** - +.. _best_tech baseline oper_technique baseline: + +:ref:`best_technique, best_baseline, oper_technique, oper_baseline + ` + Specify comma-separated lists of CLIPER/SHIFOR baseline forecasts to be derived from the BEST and operational tracks, as defined by the best_technique and oper_technique settings. From 432dd88381281622b1fc589cf19f3b44be612597 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Fri, 4 Jun 2021 13:34:41 -0600 Subject: [PATCH 30/39] testing anchor 3 --- met/docs/Users_Guide/config_options_tc.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/met/docs/Users_Guide/config_options_tc.rst b/met/docs/Users_Guide/config_options_tc.rst index f9f496933c..52550e4e7d 100644 --- a/met/docs/Users_Guide/config_options_tc.rst +++ b/met/docs/Users_Guide/config_options_tc.rst @@ -198,7 +198,7 @@ TCPairsConfig_default .. _model: -:reff:`model ` +:ref:`model ` The "model" entry specifies an array of model names to be verified. If verifying multiple models, choose descriptive model names (no whitespace) @@ -296,10 +296,10 @@ For example: lag_time = []; -.. _best_tech baseline oper_technique baseline: +.. _best_tech baseline oper_tech baseline: :ref:`best_technique, best_baseline, oper_technique, oper_baseline - ` + ` Specify comma-separated lists of CLIPER/SHIFOR baseline forecasts to be derived from the BEST and operational tracks, as defined by the From 079aa3a6471f0aaf69ef4067211fa5a4262313ae Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Fri, 4 Jun 2021 13:37:17 -0600 Subject: [PATCH 31/39] testing anchor 4 --- met/docs/Users_Guide/config_options_tc.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/met/docs/Users_Guide/config_options_tc.rst b/met/docs/Users_Guide/config_options_tc.rst index 52550e4e7d..356b58ded7 100644 --- a/met/docs/Users_Guide/config_options_tc.rst +++ b/met/docs/Users_Guide/config_options_tc.rst @@ -296,10 +296,9 @@ For example: lag_time = []; -.. _best_tech baseline oper_tech baseline: +.. _best: -:ref:`best_technique, best_baseline, oper_technique, oper_baseline - ` +:ref:`best_technique, best_baseline, oper_technique, oper_baseline ` Specify comma-separated lists of CLIPER/SHIFOR baseline forecasts to be derived from the BEST and operational tracks, as defined by the From 9f4ede4796c2d8bb84183dea9df4947a3fff471c Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Fri, 4 Jun 2021 13:56:38 -0600 Subject: [PATCH 32/39] testing anchor 45 percent --- met/docs/Users_Guide/config_options_tc.rst | 69 +++++++++++++++------- 1 file changed, 47 insertions(+), 22 deletions(-) diff --git a/met/docs/Users_Guide/config_options_tc.rst b/met/docs/Users_Guide/config_options_tc.rst index 356b58ded7..ca28f3cb7c 100644 --- a/met/docs/Users_Guide/config_options_tc.rst +++ b/met/docs/Users_Guide/config_options_tc.rst @@ -323,8 +323,10 @@ For example: oper_baseline = []; -**anly_track** - +.. _anly_track: + +:ref:`anly_track ` + Analysis tracks consist of multiple track points with a lead time of zero for the same storm. An analysis track may be generated by running model analysis fields through a tracking algorithm. Specify which datasets should @@ -341,8 +343,10 @@ For example: anly_track = BDECK; -**match_points** - +.. _match_points: + +:ref:`match_points ` + Specify whether only those track points common to both the ADECK and BDECK tracks should be written out. @@ -357,8 +361,10 @@ For example: match_points = FALSE; -**dland_file** - +.. _dland_file: + +:ref:`dland_file ` + Specify the NetCDF output of the gen_dland tool containing a gridded representation of the minimum distance to land. @@ -368,8 +374,10 @@ representation of the minimum distance to land. dland_file = "MET_BASE/tc_data/dland_nw_hem_tenth_degree.nc"; -**watch_warn** - +.. _watch_warn: + +:ref:`watch_warn ` + Specify watch/warning information. Specify an ASCII file containing watch/warning information to be used. At each track point, the most severe watch/warning status in effect, if any, will be written to the output. @@ -386,8 +394,10 @@ occurring 4 hours (-14400 second) prior to the watch/warning time. } -**basin_map** - +.. _basin_map: + +:ref:`basin_map ` + The basin_map entry defines a mapping of input names to output values. Whenever the basin string matches "key" in the input ATCF files, it is replaced with "val". This map can be used to modify basin names to make them @@ -426,7 +436,9 @@ parameter will result in missed matches. TCStatConfig_default ____________________ -**amodel, bmodel** +.. _amodel, bmodel: + +:ref:`amodel, bmodel ` Stratify by the AMODEL or BMODEL columns. Specify comma-separated lists of model names to be used for all analyses @@ -444,8 +456,9 @@ For example: amodel = []; bmodel = []; +.. _valid_beg end inc exc: -**valid_beg, valid_end, valid_inc, valid_exc** + ref:`valid_beg, valid_end, valid_inc, valid_exc ` Stratify by the VALID times. Define beginning and ending time windows in YYYYMMDD[_HH[MMSS]] @@ -468,8 +481,10 @@ For example: valid_inc = []; valid_exc = []; -**ini_hour, valid_hour, lead, lead_req** - +.. _ini valid_hour lead req: + +:ref:`ini_hour, valid_hour, lead, lead_req ` + Stratify by the initialization and valid hours and lead time. Specify a comma-separated list of initialization hours, valid hours, and lead times in HH[MMSS] format. @@ -492,7 +507,9 @@ For example: lead_req = []; -**line_type** +.. _line_type: + +:ref:`line_type ` Stratify by the LINE_TYPE column. May add using the "-line_type" job command option. @@ -506,8 +523,10 @@ For example: line_type = []; -**track_watch_warn** - +.. _track_watch_warn: + +:ref:`track_watch_warn ` + Stratify by checking the watch/warning status for each track point common to both the ADECK and BDECK tracks. If the watch/warning status of any of the track points appears in the list, retain the entire track. @@ -526,8 +545,10 @@ For example: track_watch_warn = []; -**column_thresh_name, column_thresh_val** - +.. _column_thresh_name and val: + +:ref:`column_thresh_name, column_thresh_val ` + Stratify by applying thresholds to numeric data columns. Specify a comma-separated list of columns names and thresholds to be applied. May add using the "-column_thresh name thresh" job command @@ -544,8 +565,10 @@ For example: column_thresh_name = []; column_thresh_val = []; -**column_str_name, column_str_val** - +.. _column_str_name, column_str_val: + +:ref:`column_str_name, column_str_val ` + Stratify by performing string matching on non-numeric data columns. Specify a comma-separated list of columns names and values to be included in the analysis. @@ -562,7 +585,9 @@ For example: column_str_name = []; column_str_val = []; -**column_str_exc_name, column_str_exc_val** +.. _column_str_name val: + +:ref:`column_str_exc_name, column_str_exc_val ` Stratify by performing string matching on non-numeric data columns. Specify a comma-separated list of columns names and values From 9a3db991a53bb527295e660fb0dee56c990d7591 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Fri, 4 Jun 2021 15:43:19 -0600 Subject: [PATCH 33/39] testing anchor final half --- met/docs/Users_Guide/config_options_tc.rst | 175 ++++++++++++++------- 1 file changed, 119 insertions(+), 56 deletions(-) diff --git a/met/docs/Users_Guide/config_options_tc.rst b/met/docs/Users_Guide/config_options_tc.rst index ca28f3cb7c..f9f1015195 100644 --- a/met/docs/Users_Guide/config_options_tc.rst +++ b/met/docs/Users_Guide/config_options_tc.rst @@ -8,9 +8,9 @@ See :numref:`config_options` for a description of the configuration file syntax. Configuration settings common to multiple tools _______________________________________________ -.. _storm_id: +.. _storm_id_1: -:ref:`storm_id ` +:ref:`storm_id ` Specify a comma-separated list of storm id's to be used: @@ -66,9 +66,9 @@ For example: cyclone = []; -.. _storm_name: +.. _storm_name_1: -:ref:`storm_name ` +:ref:`storm_name ` Specify a comma-separated list of storm names to be used. An empty list indicates that all should be used. @@ -108,9 +108,9 @@ For example: init_exc = []; -.. _valid_beg, valid_end: +.. _valid_beg, valid_end_1: -:ref:`valid_beg, valid_end ` +:ref:`valid_beg, valid_end ` Specify a model valid time window in YYYYMMDD[_HH[MMSS]] format. Tracks for which all valid times fall within the time window will be used. @@ -128,9 +128,9 @@ For example: valid_beg = ""; valid_end = ""; -.. _init_hour: +.. _init_hour_1: -:ref:`init_hour ` +:ref:`init_hour ` Specify a comma-separated list of model initialization hours to be used in HH[MMSS] format. An empty list indicates that all hours should be used. @@ -196,9 +196,9 @@ _____________________________________ TCPairsConfig_default ~~~~~~~~~~~~~~~~~~~~~ -.. _model: +.. _model_1: -:ref:`model ` +:ref:`model ` The "model" entry specifies an array of model names to be verified. If verifying multiple models, choose descriptive model names (no whitespace) @@ -605,8 +605,10 @@ For example: column_str_exc_name = []; column_str_exc_val = []; -**init_thresh_name, init_thresh_val** - +.. _init_thresh_name, init_thresh_val: + +:ref:`init_thresh_name, init_thresh_val ` + Just like the column_thresh options above, but apply the threshold only when lead = 0. If lead = 0 value does not meet the threshold, discard the entire track. May add using the "-init_thresh name thresh" job command @@ -622,9 +624,10 @@ For example: init_thresh_name = []; init_thresh_val = []; +.. _init_str_name, init_str_val: + +:ref:`init_str_name, init_str_val ` -**init_str_name, init_str_val** - Just like the column_str options above, but apply the string matching only when lead = 0. If lead = 0 string does not match, discard the entire track. May add using the "-init_str name thresh" job command options. @@ -640,8 +643,10 @@ For example: init_str_name = []; init_str_val = []; -**init_str_exc_name, init_str_exc_val** - +.. _init_str_exc_name and _exc_val: + +:ref:`init_str_exc_name, init_str_exc_val ` + Just like the column_str_exc options above, but apply the string matching only when lead = 0. If lead = 0 string does match, discard the entire track. May add using the "-init_str_exc name thresh" job command options. @@ -657,7 +662,9 @@ For example: init_str_exc_name = []; init_str_exc_val = []; -**water_only** +.. _water_only: + +:ref:`water_only ` Stratify by the ADECK and BDECK distances to land. Once either the ADECK or BDECK track encounters land, discard the remainder of the track. @@ -671,7 +678,9 @@ For example: water_only = FALSE; -**rirw** +.. _rirw: + +:ref:`rirw ` Specify whether only those track points for which rapid intensification or weakening of the maximum wind speed occurred in the previous time @@ -703,7 +712,9 @@ May modify using the following job command options: bdeck = adeck; Copy settings to the BDECK or specify different logic. } -**landfall, landfall_beg, landfall_end** +.. _landfall beg end: + +:ref:`landfall, landfall_beg, landfall_end ` Specify whether only those track points occurring near landfall should be retained, and define the landfall retention window as a time string in HH[MMSS] @@ -734,8 +745,10 @@ For example: landfall_beg = "-24"; landfall_end = "00"; -**event_equal** - +.. _event_equal: + +:ref:`event_equal ` + Specify whether only those cases common to all models in the dataset should be retained. May modify using the "-event_equal" job command option. @@ -749,8 +762,10 @@ For example: event_equal = FALSE; -**event_equal_lead** - +.. _event_equal_lead: + +:ref:`event_equal_lead ` + Specify lead times that must be present for a track to be included in the event equalization logic. @@ -759,8 +774,10 @@ event equalization logic. event_equal_lead = [ "12", "24", "36" ]; -**out_int_mask** - +.. _out_int_mask: + +:ref:`out_int_mask ` + Apply polyline masking logic to the location of the ADECK track at the initialization time. If it falls outside the mask, discard the entire track. May modify using the "-out_init_mask" job command option. @@ -775,8 +792,10 @@ For example: out_init_mask = ""; -**out_valid_mask** - +.. _out_valid_mask: + +:ref:`out_valid_mask ` + Apply polyline masking logic to the location of the ADECK track at the valid time. If it falls outside the mask, discard only the current track point. May modify using the "-out_valid_mask" job command option. @@ -790,8 +809,10 @@ For example: out_valid_mask = ""; -**job** - +.. _job: + +:ref:`job ` + The "jobs" entry is an array of TCStat jobs to be performed. Each element in the array contains the specifications for a single analysis job to be performed. The format for an analysis job is as follows: @@ -976,7 +997,9 @@ Where "job_name" is set to one of the following: TCGenConfig_default ___________________ -**int_freq** +.. _int_freq: + +:ref:`int_freq ` Model initialization frequency in hours, starting at 0. @@ -984,8 +1007,10 @@ Model initialization frequency in hours, starting at 0. init_freq = 6; -**lead_window** - +.. _lead_window: + +:ref:`lead_window ` + Lead times in hours to be searched for genesis events. @@ -996,7 +1021,9 @@ Lead times in hours to be searched for genesis events. end = 120; } -**min_duration** +.. _min_duration: + +:ref:`min_duration ` Minimum track duration for genesis event in hours. @@ -1004,7 +1031,9 @@ Minimum track duration for genesis event in hours. min_duration = 12; -**fcst_genesis** +.. _fcst_genesis: + +:ref:`fcst_genesis ` Forecast genesis event criteria. Defined as tracks reaching the specified intensity category, maximum wind speed threshold, and minimum sea-level @@ -1019,8 +1048,10 @@ track point where all of these criteria are met. mslp_thresh = NA; } -**best_genesis** - +.. _best_genesis: + +:ref:`best_genesis ` + BEST track genesis event criteria. Defined as tracks reaching the specified intensity category, maximum wind speed threshold, and minimum sea-level pressure threshold. The BEST track genesis time is the valid time of the @@ -1035,8 +1066,10 @@ first track point where all of these criteria are met. mslp_thresh = NA; } -**oper_genesis** - +.. _oper_genesis: + +:ref:`oper_genesis ` + Operational track genesis event criteria. Defined as tracks reaching the specified intensity category, maximum wind speed threshold, and minimum sea-level pressure threshold. The operational track genesis time is valid @@ -1054,7 +1087,9 @@ time of the first track point where all of these criteria are met. Track filtering options which may be specified separately in each filter array entry ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -**filter** +.. _filter: + +:ref:`filter ` Filter is an array of dictionaries containing the track filtering options listed below. If empty, a single filter is defined using the top-level @@ -1064,15 +1099,19 @@ settings. filter = []; -**desc** - +.. _desc: + +:ref:`desc ` + Description written to output DESC column .. code-block:: none desc = "NA"; -**model** +.. _model_2: + +:ref:`model ` Forecast ATCF ID's If empty, all ATCF ID's found will be processed. @@ -1083,7 +1122,9 @@ Statistics will be generated separately for each ATCF ID. model = []; -**storm_id** +.. _storm_id_2: + +:ref:`storm_id ` BEST and operational track storm identifiers @@ -1091,7 +1132,9 @@ BEST and operational track storm identifiers storm_id = []; -**storm_name** +.. _storm_name_2: + +:ref:`storm_name ` BEST and operational track storm names @@ -1099,8 +1142,10 @@ BEST and operational track storm names storm_name = []; -**init_beg, init_end** - +.. _init_beg, init_end2: + +:ref:`init_beg, init_end ` + Forecast and operational initialization time window .. code-block:: none @@ -1108,8 +1153,10 @@ Forecast and operational initialization time window init_beg = ""; init_end = ""; -**valid_beg, valid_end** - +.. _valid_beg, valid_end_2: + +:ref:`valid_beg, valid_end ` + Forecast, BEST, and operational valid time window .. code-block:: none @@ -1117,7 +1164,9 @@ Forecast, BEST, and operational valid time window valid_beg = ""; valid_end = ""; -**init_hour** +.. _init_hour_2: + +:ref:`init_hour ` Forecast and operational initialization hours @@ -1125,7 +1174,9 @@ Forecast and operational initialization hours init_hour = []; -**lead** +.. _lead: + +:ref:`lead ` Forecast and operational lead times in hours @@ -1133,7 +1184,9 @@ Forecast and operational lead times in hours lead = []; -**vx_mask** +.. _vx_mask: + +:ref:`vx_mask ` Spatial masking region (path to gridded data file or polyline file) @@ -1141,7 +1194,9 @@ Spatial masking region (path to gridded data file or polyline file) vx_mask = ""; -**dland_thresh** +.. _dland_thresh: + +:ref:`dland_thresh ` Distance to land threshold @@ -1149,7 +1204,9 @@ Distance to land threshold dland_thresh = NA; -**genesis_window** +.. _genesis_window: + +:ref:`genesis_window ` Genesis matching time window, in hours relative to the forecast genesis time @@ -1160,7 +1217,9 @@ Genesis matching time window, in hours relative to the forecast genesis time end = 24; } -**genesis_radius** +.. _genesis_radius: + +:ref:`genesis_radius ` Genesis matching search radius in km. @@ -1171,7 +1230,9 @@ Genesis matching search radius in km. Global settings _______________ -**ci_alpha** +.. _ci_alpha: + +:ref:`ci_alpha ` Confidence interval alpha value @@ -1179,7 +1240,9 @@ Confidence interval alpha value ci_alpha = 0.05; -**output_flag** +.. _output_flag: + +:ref:`output_flag ` Statistical output types From 282eaec9cbf1bfa05f35bc3045077c7c7fc49429 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Fri, 4 Jun 2021 15:48:43 -0600 Subject: [PATCH 34/39] fixing typo --- met/docs/Users_Guide/config_options_tc.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/met/docs/Users_Guide/config_options_tc.rst b/met/docs/Users_Guide/config_options_tc.rst index f9f1015195..66505a34df 100644 --- a/met/docs/Users_Guide/config_options_tc.rst +++ b/met/docs/Users_Guide/config_options_tc.rst @@ -229,7 +229,7 @@ For example: check_dup = FALSE; -interp12: +.. _interp12: :ref:`interp12 ` From 09d933d969fd31e983f7d1dffd03ff911863404d Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Mon, 7 Jun 2021 11:27:30 -0600 Subject: [PATCH 35/39] numbering fcst, obs_1 and 2 to create different links. --- met/docs/Users_Guide/config_options.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index df9e14f434..5384c77b48 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -2383,9 +2383,9 @@ combination of the categorical threshold (cat_thresh), neighborhood width ]; } -.. _fcst, obs: +.. _fcst, obs_1: -:ref:`fcst, obs ` +:ref:`fcst, obs ` The fcst and obs entries define the fields for which Ensemble-Stat should compute rank histograms, probability integral transform histograms, @@ -2955,9 +2955,9 @@ MODE will be run. quilt = false; -.. _fcst, obs: +.. _fcst, obs_2: -:ref:`fcst, obs ` +:ref:`fcst, obs ` The object definition settings for MODE are contained within the "fcst" and "obs" entries: From a5397e3dc0d2598be70d66ca36fa84a1200f8d7b Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Mon, 7 Jun 2021 11:43:07 -0600 Subject: [PATCH 36/39] finding more anchors that need numbers to keep them separate. --- met/docs/Users_Guide/config_options.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 5384c77b48..3aed11629a 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -339,9 +339,9 @@ override the default value set in ConfigConstants. output_precision = 5; -.. _tmp_dir: +.. _tmp_dir_1: -:ref:`tmp_dir ` +:ref:`tmp_dir ` The "tmp_dir" entry in ConfigConstants defines the directory for the temporary files. The directory must exist and be writable. The environment @@ -353,9 +353,9 @@ Some tools override the temporary directory by the command line argument tmp_dir = "/tmp"; -.. _message_type_group_map: +.. _message_type_group_map_1: -:ref:`message_type_group_map ` +:ref:`message_type_group_map ` The "message_type_group_map" entry is an array of dictionaries, each containing a "key" string and "val" string. This defines a mapping of @@ -2171,9 +2171,9 @@ forecast field: The "obs_raw_plot", "wvlt_plot", and "object_plot" entries are dictionaries similar to the "fcst_raw_plot" described above. -.. _tmp_dir: +.. _tmp_dir_2: -:ref:`tmp_dir ` +:ref:`tmp_dir ` The "tmp_dir" entry is a string specifying the location where temporary files should be written. @@ -3334,9 +3334,9 @@ For example: message_type = []; -.. _message_type_group_map: +.. _message_type_group_map_2: -:ref:`message_type_group_map ` +:ref:`message_type_group_map ` Mapping of message type group name to comma-separated list of values. The default setting defines ANYAIR, ANYSFC, and ONLYSF as groups. From 43a537262d832d8ac44cc2320cb88c821d1cc184 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Mon, 7 Jun 2021 14:42:52 -0600 Subject: [PATCH 37/39] fixing warnings --- met/docs/Users_Guide/config_options.rst | 4 ++-- met/docs/Users_Guide/config_options_tc.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index 3aed11629a..df79365ca4 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -557,7 +557,7 @@ using the following entries: .. _fcst: -:ref:`fcst :` The "fcst" entry is a dictionary containing information about the field(s) to be verified. This dictionary may include the following entries: @@ -2100,7 +2100,7 @@ in those cases. .. _obs_perc_value: -:ref:`*obs_perc_value <*obs_perc_value>` +:ref:`*obs_perc_value ` Percentile value to use when obs_summary = PERC diff --git a/met/docs/Users_Guide/config_options_tc.rst b/met/docs/Users_Guide/config_options_tc.rst index 66505a34df..f3fcc75450 100644 --- a/met/docs/Users_Guide/config_options_tc.rst +++ b/met/docs/Users_Guide/config_options_tc.rst @@ -545,9 +545,9 @@ For example: track_watch_warn = []; -.. _column_thresh_name and val: +.. _column_thresh_name_and_val: -:ref:`column_thresh_name, column_thresh_val ` +:ref:`column_thresh_name, column_thresh_val ` Stratify by applying thresholds to numeric data columns. Specify a comma-separated list of columns names and thresholds From d01e91fa08b05d89b791f49ba22fde51701318e3 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Mon, 7 Jun 2021 14:55:07 -0600 Subject: [PATCH 38/39] fixing warnings --- met/docs/Users_Guide/config_options.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index df79365ca4..b6df272897 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -557,7 +557,7 @@ using the following entries: .. _fcst: -:ref:`fcst :` +:ref:`fcst ` The "fcst" entry is a dictionary containing information about the field(s) to be verified. This dictionary may include the following entries: From 50f598d4ce87f44fffa31a435beca01d64afeb3e Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Wed, 9 Jun 2021 15:12:33 -0600 Subject: [PATCH 39/39] fixing typo --- met/docs/Users_Guide/config_options.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/met/docs/Users_Guide/config_options.rst b/met/docs/Users_Guide/config_options.rst index b6df272897..af7af2ec5f 100644 --- a/met/docs/Users_Guide/config_options.rst +++ b/met/docs/Users_Guide/config_options.rst @@ -2100,7 +2100,7 @@ in those cases. .. _obs_perc_value: -:ref:`*obs_perc_value ` +:ref:`obs_perc_value ` Percentile value to use when obs_summary = PERC