Skip to content

Commit

Permalink
Per #2741, updating after reviewing
Browse files Browse the repository at this point in the history
  • Loading branch information
jprestop committed Nov 11, 2024
1 parent 07418dd commit fe0ba53
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 54 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,18 @@
#
# **Forecast:** Model for Prediction Across Scales (MPAS)
#
# **Observations:** ECMWF Reanalysis, Version 5 (ERA5)
# **Observation:** ECMWF Reanalysis, Version 5 (ERA5)
#
# **Climatology:** None
#
# **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.
# **Location:** All of the input data required for this use case can be
# found in a sample data tarball. Each use case category will have
# one or more sample data tarballs. It is only necessary to download
# the tarball with the use case’s dataset and not the entire collection
# of sample data. Click here to access 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 :ref:`running-metplus` section for more information.
#
# **Grid:** GPP 17km masking region

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,18 @@
#
# **Forecast:** Model for Prediction Across Scales (MPAS)
#
# **Observations:** Modern-Era Retrospective analysis for Research and Applications, Version 2 (MERRA2)
# **Observation:** Modern-Era Retrospective analysis for Research and Applications, Version 2 (MERRA2)
#
# **Climatology:** None
#
# **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.
# **Location:** All of the input data required for this use case can be
# found in a sample data tarball. Each use case category will have
# one or more sample data tarballs. It is only necessary to download
# the tarball with the use case’s dataset and not the entire collection
# of sample data. Click here to access 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 :ref:`running-metplus` section for more information.
#
# **Grid:** GPP 17km masking region

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,18 @@
#
# **Forecast:** Model for Prediction Across Scales (MPAS)
#
# **Observations:** Satellite ClOud and Radiation Property retrieval System (SatCORPS)
# **Observation:** Satellite ClOud and Radiation Property retrieval System (SatCORPS)
#
# **Climatology:** None
#
# **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.
# **Location:** All of the input data required for this use case can be
# found in a sample data tarball. Each use case category will have
# one or more sample data tarballs. It is only necessary to download
# the tarball with the use case’s dataset and not the entire collection
# of sample data. Click here to access 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 :ref:`running-metplus` section for more information.
#
# **Grid:** GPP 17km masking region

Expand Down Expand Up @@ -109,7 +114,7 @@
# observation fields.
# parm/use_cases/model_applications/clouds/GridStat_fcstMPAS_obsSATCORPS_lowAndTotalCloudFrac/read_input_data.py
#
.. dropdown:: parm/use_cases/model_applications/clouds/GridStat_fcstMPAS_obsSATCORPS_lowAndTotalCloudFrac/read_input_data.py
# .. dropdown:: parm/use_cases/model_applications/clouds/GridStat_fcstMPAS_obsSATCORPS_lowAndTotalCloudFrac/read_input_data.py
#
# .. highlight:: bash
# .. literalinclude:: ../../../../parm/use_cases/model_applications/clouds/GridStat_fcstMPAS_obsSATCORPS_lowAndTotalCloudFrac/read_input_data.py
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,14 @@
#
# **Climatology:** [UPDATE]
#
# **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
# The tarball should be unpacked into the directory that you will set the value of INPUT_BASE. See `Running METplus`_ section for more information.
# **Location:** All of the input data required for this use case can be
# found in a sample data tarball. Each use case category will have
# one or more sample data tarballs. It is only necessary to download
# the tarball with the use case’s dataset and not the entire collection
# of sample data. Click here to access 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 :ref:`running-metplus` section for more information.
#
# **Data source:** JEDI HofX output files in IODAv2 format

Expand Down Expand Up @@ -136,23 +141,6 @@
# run_metplus.py /path/to/StatAnalysis_fcstGFS_HofX_obsIODAv2_PyEmbed.conf /path/to/user_system.conf
#
# See :ref:`running-metplus` for more information.
#
#
#
# The following METplus configuration variables must be set correctly to run this example.:
#
# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs).
# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions
# * **MET_INSTALL_DIR** - Path to location where MET is installed locally
#
# Example User Configuration File::
#
# [dir]
# INPUT_BASE = /path/to/sample/input/data
# OUTPUT_BASE = /path/to/output/dir
# MET_INSTALL_DIR = /path/to/met-X.Y
#
# **NOTE:** All of these items must be found under the [dir] section.

##############################################################################
# Expected Output
Expand All @@ -163,7 +151,7 @@
# 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 {OUTPUT_BASE}/model_applications/data_assimilation/StatAnalysis_IODAv2
# Output for this use case will be found in {OUTPUT_BASE}/StatAnalysis_IODAv2
# and will contain the following file::
#
# * dump.out
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,14 @@
#
# **Data source:** JEDI HofX output files in IODA format
#
# **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
# The tarball should be unpacked into the directory that you will set the value of INPUT_BASE.
# See `Running METplus`_ section for more information.
# **Location:** All of the input data required for this use case can be
# found in a sample data tarball. Each use case category will have
# one or more sample data tarballs. It is only necessary to download
# the tarball with the use case’s dataset and not the entire collection
# of sample data. Click here to access 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 :ref:`running-metplus` section for more information.

##############################################################################
# METplus Components
Expand Down Expand Up @@ -144,20 +147,7 @@
#
# run_metplus.py /path/to/StatAnalysis_fcstHAFS_obsPrepBufr_JEDI_IODA_interface.conf /path/to/user_system.conf
#
# The following METplus configuration variables must be set correctly to run this example.:
#
# | * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs).
# | * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions
# | * **MET_INSTALL_DIR** - Path to location where MET is installed locally
#
# Example User Configuration File::
#
# [dir]
# INPUT_BASE = /path/to/sample/input/data
# OUTPUT_BASE = /path/to/output/dir
# MET_INSTALL_DIR = /path/to/met-X.Y
#
# **NOTE:** All of these items must be found under the [dir] section.
# See :ref:`running-metplus` for more information.

##############################################################################
# Expected Output
Expand All @@ -168,7 +158,7 @@
# 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 {OUTPUT_BASE}/model_applications/data_assimilation/StatAnalysis_HofX
# Output for this use case will be found in {OUTPUT_BASE}/StatAnalysis_HofX
# and will contain the following file::
#
# * dump.out
Expand Down

0 comments on commit fe0ba53

Please sign in to comment.