-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
per #1489, added documentation for new use case and added quick searc…
…h keyword for new wrapper
- Loading branch information
1 parent
3de8a75
commit 4071159
Showing
3 changed files
with
117 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
113 changes: 113 additions & 0 deletions
113
docs/use_cases/met_tool_wrapper/PlotPointObs/PlotPointObs.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,113 @@ | ||
""" | ||
PlotPointObs: Basic Use Case | ||
========================== | ||
met_tool_wrapper/PlotPointObs/PlotPointObs.conf | ||
""" | ||
############################################################################## | ||
# Scientific Objective | ||
# -------------------- | ||
# | ||
# Generate a postscript image to plot point observations using a gridded | ||
# file to define the domain to plot the points. | ||
|
||
############################################################################## | ||
# Datasets | ||
# -------- | ||
# | ||
# | **Point Observations:** NetCDF generated by PB2NC and ASCII2NC | ||
# | **Grid:** GRIB2 NAM | ||
# | ||
# | **Location:** All of the input data required for this use case can be found in the met_test sample data tarball. Click here to the METplus releases page and download sample data for the appropriate release: https://github.com/dtcenter/METplus/releases | ||
# | This tarball should be unpacked into the directory that you will set the value of INPUT_BASE. See 'Running METplus' section for more information. | ||
# | ||
# | **Data Source:** NAM and NDAS | ||
# | | ||
|
||
############################################################################## | ||
# METplus Components | ||
# ------------------ | ||
# | ||
# This use case utilizes the METplus PlotPointObs wrapper to generate a | ||
# command to run the MET tool plot_point_obs if all required files are found. | ||
|
||
############################################################################## | ||
# METplus Workflow | ||
# ---------------- | ||
# | ||
# PlotPointObs is the only tool called in this example. | ||
# It processes the following run time: | ||
# | ||
# | **Valid:** 2012-04-09 12Z | ||
# | **Forecast lead:** 12 hour | ||
# | | ||
|
||
############################################################################## | ||
# METplus Configuration | ||
# --------------------- | ||
# | ||
# METplus first loads the default configuration file found in parm/metplus_config, | ||
# then it loads any configuration files passed to METplus via the command line: | ||
# parm/use_cases/met_tool_wrapper/PlotPointObs/PlotPointObs.conf | ||
# | ||
# .. highlight:: bash | ||
# .. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/PlotPointObs/PlotPointObs.conf | ||
|
||
############################################################################## | ||
# MET Configuration | ||
# ----------------- | ||
# | ||
# METplus sets environment variables based on user settings in the METplus configuration file. | ||
# See :ref:`How METplus controls MET config file settings<metplus-control-met>` for more details. | ||
# | ||
# **YOU SHOULD NOT SET ANY OF THESE ENVIRONMENT VARIABLES YOURSELF! THEY WILL BE OVERWRITTEN BY METPLUS WHEN IT CALLS THE MET TOOLS!** | ||
# | ||
# If there is a setting in the MET configuration file that is currently not supported by METplus you'd like to control, please refer to: | ||
# :ref:`Overriding Unsupported MET config file settings<met-config-overrides>` | ||
# | ||
# .. note:: See the :ref:`PlotPointObs MET Configuration<plot-point-obs-met-conf>` section of the User's Guide for more information on the environment variables used in the file below: | ||
# | ||
# .. highlight:: bash | ||
# .. literalinclude:: ../../../../parm/met_config/PlotPointObsConfig_wrapped | ||
|
||
|
||
############################################################################## | ||
# Running METplus | ||
# --------------- | ||
# | ||
# Pass the use case configuration file to the run_metplus.py script | ||
# along with any user-specific system configuration files if desired:: | ||
# | ||
# run_metplus.py /path/to/METplus/parm/use_cases/met_tool_wrapper/PlotPointObs/PlotPointObs.conf /path/to/user_system.conf | ||
# | ||
# See :ref:`running-metplus` for more information. | ||
|
||
############################################################################## | ||
# Expected Output | ||
# --------------- | ||
# | ||
# A successful run will output the following both to the screen and to the logfile:: | ||
# | ||
# INFO: METplus has successfully finished running. | ||
# | ||
# Refer to the value set for **OUTPUT_BASE** to find where the output data was generated. | ||
# Output for this use case will be found in plot_point_obs | ||
# (relative to **OUTPUT_BASE**) | ||
# and will contain the following file: | ||
# | ||
# * nam_and_ndas.20120409.t12z.prepbufr_CONFIG.ps | ||
|
||
############################################################################## | ||
# Keywords | ||
# -------- | ||
# | ||
# .. note:: | ||
# | ||
# * PlotPointObsToolUseCase | ||
# * GRIBFileUseCase | ||
# * NetCDFFileUseCase | ||
# | ||
# Navigate to the :ref:`quick-search` page to discover other similar use cases. | ||
# | ||
# sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-PlotPointObs.png' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
PlotPointObs | ||
------------ |