marine and cryosphere datasets and workflow

docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.py

@@ -29,19 +29,24 @@
 # Datasets
 # --------
 #
-# | **Forecast:** RTOFS sst file via Python Embedding script/file
+# **Forecast:** RTOFS sst file via Python Embedding script/file
 #
-# | **Observations:** GHRSST sst file via Python Embedding script/file
+# **Observations:** GHRSST sst file via Python Embedding script/file
 #
-# | **Sea Ice Masking:** RTOFS ice cover file via Python Embedding script/file
+# **Sea Ice Masking:** RTOFS ice cover file via Python Embedding script/file
 #
-# | **Climatology:** WOA sst file via Python Embedding script/file
+# **Climatology:** WOA sst file via Python Embedding script/file
 #
-# | **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.
 #
-# | **Data Source:** JPL's PODAAC and NCEP's FTPPRD data servers
-# |
+# **Data Source:** JPL's PODAAC and NCEP's FTPPRD data servers
 
 ##############################################################################
 # External Dependencies
@@ -70,13 +75,20 @@
 # METplus Workflow
 # ----------------
 #
+# **Beginning time (VALID_BEG):** 20210503
+#
+# **End time (VALID_END):** 20210503
+#
+# **Increment between beginning and end times (VALID_INCREMENT):** 1M
+#
+# **Sequence of forecast leads to process (LEAD_SEQ):** 0
+#
 # GridStat is the only tool called in this example. This use case will pass in both the observation, forecast, 
 # and climatology gridded data being pulled from the files via Python Embedding. All of the desired statistics 
 # reside in the CNT line type, so that is the only output requested.
 # It processes the following run time:
 #
-# | **Valid:** 2021-05-03 0Z
-# |
+# **Valid:** 2021-05-03 0Z
 
 ##############################################################################
 # METplus Configuration

docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.py

@@ -29,15 +29,22 @@
 # Datasets
 # --------
 #
-# | **Forecast:** RTOFS ice cover file via Python Embedding script/file
+# **Forecast:** RTOFS ice cover file via Python Embedding script/file
 #
-# | **Observation:** OSTIA ice cover file via Python Embedding script/file
+# **Observation:** OSTIA ice cover file via Python Embedding script/file
 #
-# | **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.
+# **Climatology:** None
 #
-# | **Data Source:** JPL's PODAAC and NCEP's FTPPRD data servers
-# |
+# **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:** JPL's PODAAC and NCEP's FTPPRD data servers
 
 ##############################################################################
 # External Dependencies
@@ -67,14 +74,21 @@
 # METplus Workflow
 # ----------------
 #
+# **Beginning time (VALID_BEG):** 20190201
+#
+# **End time (VALID_END):** 20190201
+#
+# **Increment between beginning and end times (VALID_INCREMENT):** 86400
+#
+# **Sequence of forecast leads to process (LEAD_SEQ):** None
+#
 # GridStat is the only tool called in this example. This use case will pass in the two
 # hemispheres via a custom loop list, with both the observation and forecast gridded data
 # being pulled from the files via Python Embedding. All of the desired statistics reside in the CNT line type,
 # so that is the only output requested.
 # It processes the following run time:
 #
-# | **Valid:** 2021-03-05 0Z
-# |
+# **Valid:** 2021-03-05 0Z
 
 ##############################################################################
 # METplus Configuration

docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.py

@@ -29,19 +29,24 @@
 # Datasets
 # --------
 #
-# | **Forecast:** RTOFS sss file via Python Embedding script/file
+# **Forecast:** RTOFS sss file via Python Embedding script/file
 #
-# | **Observations:** SMAP sss file via Python Embedding script/file
+# **Observations:** SMAP sss file via Python Embedding script/file
 #
-# | **Sea Ice Masking:** RTOFS ice cover file via Python Embedding script/file
+# **Sea Ice Masking:** RTOFS ice cover file via Python Embedding script/file
 #
-# | **Climatology:** WOA sss file via Python Embedding script/file
+# **Climatology:** WOA sss file via Python Embedding script/file
 #
-# | **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.
 #
-# | **Data Source:** JPL's PODAAC and NCEP's FTPPRD data servers
-# |
+# **Data Source:** JPL's PODAAC and NCEP's FTPPRD data servers
 
 ##############################################################################
 # External Dependencies
@@ -70,13 +75,20 @@
 # METplus Workflow
 # ----------------
 #
+# **Beginning time (VALID_BEG):** 20210502
+#
+# **End time (VALID_END):** 20210502
+#
+# **Increment between beginning and end times (VALID_INCREMENT):** 20210502
+#
+# **Sequence of forecast leads to process (LEAD_SEQ):** 24
+#
 # GridStat is the only tool called in this example. This use case will pass in both the observation, forecast, 
 # and climatology gridded data being pulled from the files via Python Embedding. All of the desired statistics 
 # reside in the CNT line type, so that is the only output requested.
 # It processes the following run time:
 #
-# | **Valid:** 2021-05-02 0Z
-# |
+# **Valid:** 2021-05-02 0Z
 
 ##############################################################################
 # METplus Configuration

docs/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.py

@@ -29,19 +29,24 @@
 # Datasets
 # --------
 #
-# | **Forecast:** RTOFS sss file via Python Embedding script/file
+# **Forecast:** RTOFS sss file via Python Embedding script/file
 #
-# | **Observations:** SMOS sss file via Python Embedding script/file
+# **Observations:** SMOS sss file via Python Embedding script/file
 #
-# | **Sea Ice Masking:** RTOFS ice cover file via Python Embedding script/file
+# **Sea Ice Masking:** RTOFS ice cover file via Python Embedding script/file
 #
-# | **Climatology:** WOA sss file via Python Embedding script/file
+# **Climatology:** WOA sss file via Python Embedding script/file
 #
-# | **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.
 #
-# | **Data Source:** JPL's PODAAC and NCEP's FTPPRD data servers
-# |
+# **Data Source:** JPL's PODAAC and NCEP's FTPPRD data servers
 
 ##############################################################################
 # External Dependencies
@@ -70,13 +75,20 @@
 # METplus Workflow
 # ----------------
 #
+# **Beginning time (VALID_BEG):** 20210503
+#
+# **End time (VALID_END):** 20210503
+#
+# **Increment between beginning and end times (VALID_INCREMENT):** 1M
+#
+# **Sequence of forecast leads to process (LEAD_SEQ):** 0
+#
 # GridStat is the only tool called in this example. This use case will pass in both the observation, forecast, 
 # and climatology gridded data being pulled from the files via Python Embedding. All of the desired statistics 
 # reside in the CNT line type, so that is the only output requested.
 # It processes the following run time:
 #
-# | **Valid:** 2021-05-03 0Z
-# |
+# **Valid:** 2021-05-03 0Z
 
 ##############################################################################
 # METplus Configuration

docs/use_cases/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.py

@@ -28,13 +28,18 @@
 # Datasets
 # --------
 #
-# | **Input:** Python Embedding script/file, HYCOM observation file, coordinate system weight files (optional)
-#
-# | **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:** HYCOM model
-# |
+# **Input:** Python Embedding script/file, HYCOM observation file, coordinate system weight files (optional)
+#
+# **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:** HYCOM model
 
 ##############################################################################
 # External Dependencies
@@ -62,11 +67,18 @@
 # METplus Workflow
 # ----------------
 #
+# **Beginning time (VALID_BEG):** 20200127
+#
+# **End time (VALID_END):** 20200127
+#
+# **Increment between beginning and end times (VALID_INCREMENT):** 1M
+#
+# **Sequence of forecast leads to process (LEAD_SEQ):** 0
+#
 # PlotDataPlane is the only tool called in this example.
 # It processes the following run time:
 #
-# | **Valid:** 2020-01-27 0Z
-# |
+# **Valid:** 2020-01-27 0Z
 #
 # As it is currently set, the configuration file will pass in the path to the observation data,
 # as well as a path to the weights for the coordinate system. This is done in an effort to speed up running the use case.

docs/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds.py

@@ -29,32 +29,46 @@
 # Datasets
 # --------
 #
-# | **Forecast:** GFS forecast data for 10-m winds 
+# **Forecast:** GFS forecast data for 10-m winds 
 #
-# | **Observations:** ASCAT METOP-B data provided by OPC
+# **Observations:** ASCAT METOP-B data provided by OPC
 #
-# | **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.
+# **Climatology:** None
+#
+# **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
 # ------------------
 #
 # This use case calls Python Embedding during PointStat, which is the only tool used. 
-#
 
 ##############################################################################
 # METplus Workflow
 # ----------------
 #
+# **Beginning time (INIT_BEG):** 202307060000
+#
+# **End time (INIT_END):** 202307060000
+#
+# **Increment between beginning and end times (INIT_INCREMENT):** 1M
+
+# **Sequence of forecast leads to process (LEAD_SEQ):** 6
+#
 # PointStat kicks off a Python script execution, which reads in the entire directory passed as an arguement. 
 # In the script, the directory's files are included only if they are between the times that are also passed as an arguement.
 # After these points are passed back to PointStat as the point observation dataset, they are compared to gridded forecast data
 # in pre-created masking regions. MCTC and MCTS line types are output, using thresholds of relevant wind speeds.
 # The use case processes the following run time:
 #
-# | **Init:** 2023-07-06 00Z 6hr lead
-# |
+#  **Init:** 2023-07-06 00Z 6hr lead
 
 ##############################################################################
 # METplus Configuration

docs/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsJASON3_satelliteAltimetry.py

@@ -35,6 +35,8 @@
 #
 # **Observations:** JASON-3 satellite data
 #
+# **Climatology:** None
+#
 # **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 
@@ -54,12 +56,20 @@
 # METplus Workflow
 # ----------------
 #
+# **Beginning time (VALID_BEG):** 20240102_12
+#
+# **End time (VALID_END):** 20240102_12
+#
+# **Increment between beginning and end times (VALID_INCREMENT):** 1d
+#
+# **Sequence of forecast leads to process (LEAD_SEQ):** 12
+#
 # PointStat kicks off a Python script execution, which reads in the file name, variable field of interest, and type of file (JASON, SARAL, or SENTINEL). 
 # After these points are passed back to PointStat as the point observation dataset, they are compared to gridded forecast data. 
 # CTC and CTS line types are output, which can be adjusted for additional wind speeds/ wave heights.
 # The use case processes the following run time:
 #
-# | **Valid:** 2024-01-02 12Z 12hr lead
+# **Valid:** 2024-01-02 12Z 12hr lead
 
 ##############################################################################
 # METplus Configuration