Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature #1402 config cleanup - met_tool_wrapper #1690

Merged
merged 13 commits into from
Jul 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions docs/Users_Guide/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9605,3 +9605,46 @@ METplus Configuration Glossary
Guide for more information on multi-variate MODE.

| *Used by:* MODE

CYCLONE_PLOTTER_GLOBAL_PLOT
Set to True to plot entire global extent in CyclonePlotter or set to False
to generate a plot of a defined region of the world, then define lons and
lats with :term:`CYCLONE_PLOTTER_WEST_LON`,
:term:`CYCLONE_PLOTTER_EAST_LON`, :term:`CYCLONE_PLOTTER_SOUTH_LAT`, and
:term:`CYCLONE_PLOTTER_NORTH_LAT`.

| *Used by:* CyclonePlotter

CYCLONE_PLOTTER_WEST_LON
Set the west longitude boundary for CyclonePlotter.
Only used if :term:`CYCLONE_PLOTTER_GLOBAL_PLOT` is False.

| *Used by:* CyclonePlotter

CYCLONE_PLOTTER_EAST_LON
Set the east longitude boundary for CyclonePlotter.
Only used if :term:`CYCLONE_PLOTTER_GLOBAL_PLOT` is False.

| *Used by:* CyclonePlotter

CYCLONE_PLOTTER_SOUTH_LAT
Set the south latitude boundary for CyclonePlotter.
Only used if :term:`CYCLONE_PLOTTER_GLOBAL_PLOT` is False.

| *Used by:* CyclonePlotter

CYCLONE_PLOTTER_NORTH_LAT
Set the north latitude boundary for CyclonePlotter.
Only used if :term:`CYCLONE_PLOTTER_GLOBAL_PLOT` is False.

| *Used by:* CyclonePlotter

CYCLONE_PLOTTER_ANNOTATION_FONT_SIZE
Set the annotation font size for CyclonePlotter output.

| *Used by:* CyclonePlotter

CYCLONE_PLOTTER_RESOLUTION_DPI
Set the resolution for CyclonePlotter output.

| *Used by:* CyclonePlotter
7 changes: 7 additions & 0 deletions docs/Users_Guide/wrappers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,13 @@ METplus Configuration
| :term:`CYCLONE_PLOTTER_CROSS_MARKER_SIZE`
| :term:`CYCLONE_PLOTTER_GENERATE_TRACK_ASCII`
| :term:`CYCLONE_PLOTTER_ADD_WATERMARK`
| :term:`CYCLONE_PLOTTER_GLOBAL_PLOT`
| :term:`CYCLONE_PLOTTER_WEST_LON`
| :term:`CYCLONE_PLOTTER_EAST_LON`
| :term:`CYCLONE_PLOTTER_NORTH_LAT`
| :term:`CYCLONE_PLOTTER_SOUTH_LAT`
| :term:`CYCLONE_PLOTTER_ANNOTATION_FONT_SIZE`
| :term:`CYCLONE_PLOTTER_RESOLUTION_DPI`
|

.. warning:: **DEPRECATED:**
Expand Down
102 changes: 38 additions & 64 deletions parm/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC.conf
Original file line number Diff line number Diff line change
@@ -1,79 +1,72 @@
[config]
## Configuration-related settings such as the process list, begin and end times, etc.

# List of applications to run - only ASCII2NC for this case
# Documentation for this use case can be found at
# https://metplus.readthedocs.io/en/latest/generated/met_tool_wrapper/ASCII2NC/ASCII2NC.html

# For additional information, please see the METplus Users Guide.
# https://metplus.readthedocs.io/en/latest/Users_Guide

###
# Processes to run
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#process-list
###

PROCESS_LIST = ASCII2NC

# time looping - options are INIT, VALID, RETRO, and REALTIME

###
# Time Info
# LOOP_BY options are INIT, VALID, RETRO, and REALTIME
# If set to INIT or RETRO:
# INIT_TIME_FMT, INIT_BEG, INIT_END, and INIT_INCREMENT must also be set
# If set to VALID or REALTIME:
# VALID_TIME_FMT, VALID_BEG, VALID_END, and VALID_INCREMENT must also be set
LOOP_BY = VALID
# LEAD_SEQ is the list of forecast leads to process
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#timing-control
###

# Format of VALID_BEG and VALID_END using % items
# %Y = 4 digit year, %m = 2 digit month, %d = 2 digit day, etc.
# see www.strftime.org for more information
# %Y%m%d%H expands to YYYYMMDDHH
LOOP_BY = VALID
VALID_TIME_FMT = %Y%m%d%H

# Start time for METplus run - must match VALID_TIME_FMT
VALID_BEG = 2010010112

# End time for METplus run - must match VALID_TIME_FMT
VALID_END = 2010010112

# Increment between METplus runs (in seconds if no units are specified)
# Must be >= 60 seconds
VALID_INCREMENT = 1M

# List of forecast leads to process for each run time (init or valid)
# If unset, defaults to 0 (don't loop through forecast leads
LEAD_SEQ = 0

# Order of loops to process data - Options are times, processes
# Not relevant if only one item is in the PROCESS_LIST
# times = run all wrappers in the PROCESS_LIST for a single run time, then
# increment the run time and run all wrappers again until all times have
# been evaluated.
# processes = run the first wrapper in the PROCESS_LIST for all times
# specified, then repeat for the next item in the PROCESS_LIST until all
# wrappers have been run
LOOP_ORDER = times

# Verbosity of MET output - overrides LOG_VERBOSITY for ASCII2NC only
#LOG_ASCII2NC_VERBOSITY = 1

# MET Configuration file for ASCII2NC
# References CONFIG_DIR from the [dir] section
ASCII2NC_CONFIG_FILE = {CONFIG_DIR}/Ascii2NcConfig_wrapped
###
# File I/O
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
###

ASCII2NC_INPUT_DIR =
ASCII2NC_INPUT_TEMPLATE = {INPUT_BASE}/met_test/data/sample_obs/ascii/precip24_{valid?fmt=%Y%m%d%H}.ascii

ASCII2NC_OUTPUT_DIR =
ASCII2NC_OUTPUT_TEMPLATE = {OUTPUT_BASE}/ascii2nc/precip24_{valid?fmt=%Y%m%d%H}.nc

# If set to True, skip run if the output file determined by the output directory and
# filename template already exists
ASCII2NC_SKIP_IF_OUTPUT_EXISTS = False

# Time relative to valid time (in seconds if no units are specified) to allow files to be considered
# valid. Set both BEGIN and END to 0 to require the exact time in the filename
# Not used in this example.
ASCII2NC_FILE_WINDOW_BEGIN = 0
ASCII2NC_FILE_WINDOW_END = 0

# Value to pass with the -format argument to ascii2nc. See MET User's Guide for more information
###
# ASCII2NC Settings
# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#ascii2nc
###

#LOG_ASCII2NC_VERBOSITY = 1

ASCII2NC_CONFIG_FILE = {PARM_BASE}/met_config/Ascii2NcConfig_wrapped

ASCII2NC_INPUT_FORMAT =

# Value to pass with the -mask_grid argument to ascii2nc. See MET User's Guide for more information
ASCII2NC_MASK_GRID =

# Value to pass with the -mask_poly argument to ascii2nc. See MET User's Guide for more information
ASCII2NC_MASK_POLY =

# Value to pass with the -mask_sid argument to ascii2nc. See MET User's Guide for more information
ASCII2NC_MASK_SID =

# For defining the time periods for summarization
# False for no time summary, True otherwise
# The rest of the ASCII2NC_TIME_SUMMARY variables are ignored if set to False
# See the MET User's Guide section regarding ASCII2NC time summary options for more information.
ASCII2NC_TIME_SUMMARY_FLAG = False
ASCII2NC_TIME_SUMMARY_RAW_DATA = False
ASCII2NC_TIME_SUMMARY_BEG = 000000
Expand All @@ -85,22 +78,3 @@ ASCII2NC_TIME_SUMMARY_VAR_NAMES =
ASCII2NC_TIME_SUMMARY_TYPES = min, max, range, mean, stdev, median, p80
ASCII2NC_TIME_SUMMARY_VALID_FREQ = 0
ASCII2NC_TIME_SUMMARY_VALID_THRESH = 0.0


# End of [config] section and start of [dir] section
[dir]
# location of configuration files used by MET applications
CONFIG_DIR={PARM_BASE}/met_config

# Input/Output directories can be left empty if the corresponding template contains the full path to the files
ASCII2NC_INPUT_DIR =
ASCII2NC_OUTPUT_DIR =

# End of [dir] section and start of [filename_templates] section
[filename_templates]

# Template to look for input to ASCII2NC relative to ASCII2NC_INPUT_DIR
ASCII2NC_INPUT_TEMPLATE = {INPUT_BASE}/met_test/data/sample_obs/ascii/precip24_{valid?fmt=%Y%m%d%H}.ascii

# Template to use to write output from ASCII2NC
ASCII2NC_OUTPUT_TEMPLATE = {OUTPUT_BASE}/ascii2nc/precip24_{valid?fmt=%Y%m%d%H}.nc
Original file line number Diff line number Diff line change
@@ -1,84 +1,75 @@
[config]
## Configuration-related settings such as the process list, begin and end times, etc.

# List of applications to run - only ASCII2NC for this case
# Documentation for this use case can be found at
# https://metplus.readthedocs.io/en/latest/generated/met_tool_wrapper/ASCII2NC/ASCII2NC_python_embedding.html

# For additional information, please see the METplus Users Guide.
# https://metplus.readthedocs.io/en/latest/Users_Guide

###
# Processes to run
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#process-list
###

PROCESS_LIST = ASCII2NC

# time looping - options are INIT, VALID, RETRO, and REALTIME

###
# Time Info
# LOOP_BY options are INIT, VALID, RETRO, and REALTIME
# If set to INIT or RETRO:
# INIT_TIME_FMT, INIT_BEG, INIT_END, and INIT_INCREMENT must also be set
# If set to VALID or REALTIME:
# VALID_TIME_FMT, VALID_BEG, VALID_END, and VALID_INCREMENT must also be set
LOOP_BY = VALID
# LEAD_SEQ is the list of forecast leads to process
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#timing-control
###

# Format of VALID_BEG and VALID_END using % items
# %Y = 4 digit year, %m = 2 digit month, %d = 2 digit day, etc.
# see www.strftime.org for more information
# %Y%m%d%H expands to YYYYMMDDHH
LOOP_BY = VALID
VALID_TIME_FMT = %Y%m%d%H

# Start time for METplus run - must match VALID_TIME_FMT
VALID_BEG = 2010010112

# End time for METplus run - must match VALID_TIME_FMT
VALID_END = 2010010112

# Increment between METplus runs (in seconds if no units are specified)
# Must be >= 60 seconds
VALID_INCREMENT = 1M

# List of forecast leads to process for each run time (init or valid)
# If unset, defaults to 0 (don't loop through forecast leads
LEAD_SEQ = 0

# Order of loops to process data - Options are times, processes
# Not relevant if only one item is in the PROCESS_LIST
# times = run all wrappers in the PROCESS_LIST for a single run time, then
# increment the run time and run all wrappers again until all times have
# been evaluated.
# processes = run the first wrapper in the PROCESS_LIST for all times
# specified, then repeat for the next item in the PROCESS_LIST until all
# wrappers have been run
LOOP_ORDER = times

# Verbosity of MET output - overrides LOG_VERBOSITY for ASCII2NC only
#LOG_ASCII2NC_VERBOSITY = 1

# MET Configuration file for ASCII2NC
# References CONFIG_DIR from the [dir] section
ASCII2NC_CONFIG_FILE =
###
# File I/O
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
###

ASCII2NC_INPUT_DIR =
ASCII2NC_INPUT_TEMPLATE = "{MET_INSTALL_DIR}/share/met/python/read_ascii_point.py {INPUT_BASE}/met_test/data/sample_obs/ascii/sample_ascii_obs.txt"

ASCII2NC_OUTPUT_DIR =
ASCII2NC_OUTPUT_TEMPLATE = {OUTPUT_BASE}/met_tool_wrapper/ASCII2NC/ascii2nc_python.nc

# If set to True, skip run if the output file determined by the output directory and
# filename template already exists
ASCII2NC_SKIP_IF_OUTPUT_EXISTS = False

# Time relative to valid time (in seconds if no units are specified) to allow files to be considered
# valid. Set both BEGIN and END to 0 to require the exact time in the filename
# Not used in this example.
ASCII2NC_FILE_WINDOW_BEGIN = 0
ASCII2NC_FILE_WINDOW_END = 0

# Time relative to each input file's valid time (in seconds if no units are specified) for data within the file to be
# considered valid.

###
# ASCII2NC Settings
# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#ascii2nc
###

#LOG_ASCII2NC_VERBOSITY = 1
#ASCII2NC_CONFIG_FILE =

ASCII2NC_WINDOW_BEGIN = 0
ASCII2NC_WINDOW_END = 0

# Value to pass with the -format argument to ascii2nc. See MET User's Guide for more information
ASCII2NC_INPUT_FORMAT = python

# Value to pass with the -mask_grid argument to ascii2nc. See MET User's Guide for more information
ASCII2NC_MASK_GRID =

# Value to pass with the -mask_poly argument to ascii2nc. See MET User's Guide for more information
ASCII2NC_MASK_POLY =

# Value to pass with the -mask_sid argument to ascii2nc. See MET User's Guide for more information
ASCII2NC_MASK_SID =

# For defining the time periods for summarization
# False for no time summary, True otherwise
# The rest of the ASCII2NC_TIME_SUMMARY variables are ignored if set to False
# See the MET User's Guide section regarding ASCII2NC time summary options for more information.
ASCII2NC_TIME_SUMMARY_FLAG = False
ASCII2NC_TIME_SUMMARY_RAW_DATA = False
ASCII2NC_TIME_SUMMARY_BEG = 000000
Expand All @@ -90,22 +81,3 @@ ASCII2NC_TIME_SUMMARY_VAR_NAMES =
ASCII2NC_TIME_SUMMARY_TYPES = min, max, range, mean, stdev, median, p80
ASCII2NC_TIME_SUMMARY_VALID_FREQ = 0
ASCII2NC_TIME_SUMMARY_VALID_THRESH = 0.0


# End of [config] section and start of [dir] section
[dir]
# location of configuration files used by MET applications
CONFIG_DIR={PARM_BASE}/met_config

# Input/Output directories can be left empty if the corresponding template contains the full path to the files
ASCII2NC_INPUT_DIR =
ASCII2NC_OUTPUT_DIR =

# End of [dir] section and start of [filename_templates] section
[filename_templates]

# Template to look for input to ASCII2NC relative to ASCII2NC_INPUT_DIR
ASCII2NC_INPUT_TEMPLATE = "{MET_INSTALL_DIR}/share/met/python/read_ascii_point.py {INPUT_BASE}/met_test/data/sample_obs/ascii/sample_ascii_obs.txt"

# Template to use to write output from ASCII2NC
ASCII2NC_OUTPUT_TEMPLATE = {OUTPUT_BASE}/met_tool_wrapper/ASCII2NC/ascii2nc_python.nc
Loading