Skip to content

Commit

Permalink
Feature 896 more met config (#1322)
Browse files Browse the repository at this point in the history
  • Loading branch information
@georgemccabe
georgemccabe authored Dec 27, 2021
1 parent 1af654c commit 46658c6
Show file tree
Hide file tree
Showing 33 changed files with 1,086 additions and 649 deletions.
8 changes: 4 additions & 4 deletions docs/Contributors_Guide/basic_components.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -302,12 +302,12 @@ data type, extra info, children, and nicknames.
* extra: Additional info as a comma separated string (see extra_args above)
* children: Dictionary defining a nested dictionary where the key is the name
of the sub-directory and the value is the item info (see items above)
* nicknames: List of METplus variable names (with app name excluded) to also
* nicknames: List of METplus variable names to also
search and use if it is set. For example, the GridStat variable mask.poly is
set by the METplus config variable GRID_STAT_MASK_POLY. However, in older
versions of the METplus wrappers, the variable used was
GRID_STAT_VERIFICATION_MASK_TEMPLATE. To preserve support for this name, the
nickname can be set to ['VERIFICATION_MASK_TEMPLATE'] and the old variable
nickname can be set to [f'{self.app_name.upper()}_VERIFICATION_MASK_TEMPLATE'] and the old variable
will be checked if GRID_STAT_MASK_POLY is not set.

Values must be set to None to preserve the order.
Expand All @@ -320,7 +320,7 @@ CompareGriddedWrapper and is used by GridStat, PointStat, and EnsembleStat::

def handle_climo_cdf_dict(self):
self.add_met_config_dict('climo_cdf', {
'cdf_bins': ('float', None, None, ['CLIMO_CDF_BINS']),
'cdf_bins': ('float', None, None, [f'{self.app_name.upper()}_CLIMO_CDF_BINS']),
'center_bins': 'bool',
'write_bins': 'bool',
})
Expand All @@ -329,7 +329,7 @@ This function handles setting the climo_cdf dictionary. The METplus config
variable that fits the format {APP_NAME}_{DICTIONARY_NAME}_{VARIABLE_NAME},
i.e. GRID_STAT_CLIMO_CDF_CDF_BINS for GridStat's climo_cdf.cdf_bins, is
quieried first. However, this default name is a little redundant, so adding
the nickname 'CLIMO_CDF_BINS' allows the user to set the variable
the nickname 'GRID_STAT_CLIMO_CDF_BINS' allows the user to set the variable
GRID_STAT_CLIMO_CDF_BINS instead.

There are many MET config dictionaries that only contain beg and end to define
Expand Down
164 changes: 154 additions & 10 deletions docs/Users_Guide/glossary.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3431,9 +3431,7 @@ METplus Configuration Glossary
| *Used by:* PB2NC
POINT_STAT_STATION_ID
Specify the ID of a specific station to use with the MET point_stat tool.

| *Used by:* PointStat
.. warning:: **DEPRECATED:** Please use :term:`POINT_STAT_MASK_SID` instead.

POINT_STAT_VERIFICATION_MASK_TEMPLATE
Template used to specify the verification mask filename for the MET tool point_stat. Now supports a list of filenames.
Expand Down Expand Up @@ -3734,17 +3732,13 @@ METplus Configuration Glossary
.. warning:: **DEPRECATED:** Please use :term:`MAKE_PLOTS_INPUT_DIR` instead.

SERIES_ANALYSIS_STAT_LIST
Specify a list of statistics to be computed by the MET series_analysis tool. Sets the 'cnt' value in the output_stats dictionary in the MET SeriesAnalysis config file

| *Used by:* SeriesAnalysis
.. warning:: **DEPRECATED:** Please use :term:`SERIES_ANALYSIS_OUTPUT_STATS_CNT` instead.

SERIES_ANALYSIS_CTS_LIST
Specify a list of contingency table statistics to be computed by the MET series_analysis tool. Sets the 'cts' value in the output_stats dictionary in the MET SeriesAnalysis config file

| *Used by:* SeriesAnalysis
.. warning:: **DEPRECATED:** Please use :term:`SERIES_ANALYSIS_OUTPUT_STATS_CTS` instead.

STAT_LIST
.. warning:: **DEPRECATED:** Please use :term:`SERIES_ANALYSIS_STAT_LIST` instead.
.. warning:: **DEPRECATED:** Please use :term:`SERIES_ANALYSIS_OUTPUT_STATS_CNT` instead.

STORM_ID
.. warning:: **DEPRECATED:** Please use :term:`TC_PAIRS_STORM_ID` or :term:`TC_STAT_STORM_ID`.
Expand Down Expand Up @@ -6066,6 +6060,11 @@ METplus Configuration Glossary

| *Used by:* PointStat
POINT_STAT_MASK_LLPNT
Specify the value for 'mask.llpnt' in the MET configuration file for PointStat.

| *Used by:* PointStat
MODE_GRID_RES
Set the grid_res entry in the MODE MET config file.

Expand Down Expand Up @@ -8530,6 +8529,151 @@ METplus Configuration Glossary

| *Used by:* EnsembleStat
GRID_STAT_FOURIER_WAVE_1D_BEG
Specify the value for 'fourier.wave_1d_beg' in the MET configuration file for GridStat.

| *Used by:* GridStat
GRID_STAT_FOURIER_WAVE_1D_END
Specify the value for 'fourier.wave_1d_end' in the MET configuration file for GridStat.

| *Used by:* GridStat
PB2NC_OBS_BUFR_MAP
Specify the value for 'obs_bufr_map' in the MET configuration file for PB2NC.

| *Used by:* PB2NC
PB2NC_OBS_PREPBUFR_MAP
Specify the value for 'obs_prepbufr_map' in the MET configuration file for PB2NC.

| *Used by:* PB2NC
POINT_STAT_HIRA_FLAG
Specify the value for 'hira.flag' in the MET configuration file for PointStat.

| *Used by:* PointStat
POINT_STAT_HIRA_WIDTH
Specify the value for 'hira.width' in the MET configuration file for PointStat.

| *Used by:* PointStat
POINT_STAT_HIRA_VLD_THRESH
Specify the value for 'hira.vld_thresh' in the MET configuration file for PointStat.

| *Used by:* PointStat
POINT_STAT_HIRA_COV_THRESH
Specify the value for 'hira.cov_thresh' in the MET configuration file for PointStat.

| *Used by:* PointStat
POINT_STAT_HIRA_SHAPE
Specify the value for 'hira.shape' in the MET configuration file for PointStat.

| *Used by:* PointStat
POINT_STAT_HIRA_PROB_CAT_THRESH
Specify the value for 'hira.prob_cat_thresh' in the MET configuration file for PointStat.

| *Used by:* PointStat
POINT_STAT_MESSAGE_TYPE_GROUP_MAP
Specify the value for 'message_type_group_map' in the MET configuration file for PointStat.

| *Used by:* PointStat
TC_PAIRS_CHECK_DUP
Specify the value for 'check_dup' in the MET configuration file for TCPairs.

| *Used by:* TCPairs
TC_PAIRS_INTERP12
Specify the value for 'interp12' in the MET configuration file for TCPairs.

| *Used by:* TCPairs
SERIES_ANALYSIS_OUTPUT_STATS_FHO
Specify the value for 'output_stats.fho' in the MET configuration file for SeriesAnalysis.

| *Used by:* SeriesAnalysis
SERIES_ANALYSIS_OUTPUT_STATS_CTC
Specify the value for 'output_stats.ctc' in the MET configuration file for SeriesAnalysis.

| *Used by:* SeriesAnalysis
SERIES_ANALYSIS_OUTPUT_STATS_CTS
Specify the value for 'output_stats.cts' in the MET configuration file for SeriesAnalysis.

| *Used by:* SeriesAnalysis
SERIES_ANALYSIS_OUTPUT_STATS_MCTC
Specify the value for 'output_stats.mctc' in the MET configuration file for SeriesAnalysis.

| *Used by:* SeriesAnalysis
SERIES_ANALYSIS_OUTPUT_STATS_MCTS
Specify the value for 'output_stats.mcts' in the MET configuration file for SeriesAnalysis.

| *Used by:* SeriesAnalysis
SERIES_ANALYSIS_OUTPUT_STATS_CNT
Specify the value for 'output_stats.cnt' in the MET configuration file for SeriesAnalysis. Also used to generate plots for each value in the list.

| *Used by:* SeriesAnalysis
SERIES_ANALYSIS_OUTPUT_STATS_SL1L2
Specify the value for 'output_stats.sl1l2' in the MET configuration file for SeriesAnalysis.

| *Used by:* SeriesAnalysis
SERIES_ANALYSIS_OUTPUT_STATS_SAL1L2
Specify the value for 'output_stats.sal1l2' in the MET configuration file for SeriesAnalysis.

| *Used by:* SeriesAnalysis
SERIES_ANALYSIS_OUTPUT_STATS_PCT
Specify the value for 'output_stats.pct' in the MET configuration file for SeriesAnalysis.

| *Used by:* SeriesAnalysis
SERIES_ANALYSIS_OUTPUT_STATS_PSTD
Specify the value for 'output_stats.pstd' in the MET configuration file for SeriesAnalysis.

| *Used by:* SeriesAnalysis
SERIES_ANALYSIS_OUTPUT_STATS_PJC
Specify the value for 'output_stats.pjc' in the MET configuration file for SeriesAnalysis.

| *Used by:* SeriesAnalysis
SERIES_ANALYSIS_OUTPUT_STATS_PRC
Specify the value for 'output_stats.prc' in the MET configuration file for SeriesAnalysis.

| *Used by:* SeriesAnalysis
MODE_PS_PLOT_FLAG
Specify the value for 'ps_plot_flag' in the MET configuration file for MODE.

| *Used by:* MODE
MODE_CT_STATS_FLAG
Specify the value for 'ct_stats_flag' in the MET configuration file for MODE.

| *Used by:* MODE
GRID_STAT_CENSOR_THRESH
Specify the value for 'censor_thresh' in the MET configuration file for GridStat.

| *Used by:* GridStat
GRID_STAT_CENSOR_VAL
Specify the value for 'censor_val' in the MET configuration file for GridStat.

| *Used by:* GridStat
INIT_LIST
List of initialization times to process.
This variable is used when intervals between run times are irregular.
Expand Down
Loading

0 comments on commit 46658c6

Please sign in to comment.