Feature #1977 ARGO use case (#2148)

Co-authored-by: j-opatz <[email protected]>

.github/parm/use_case_groups.json

@@ -84,6 +84,11 @@
     "index_list": "7",
     "run": false
   },
+  {
+    "category": "marine_and_cryosphere",
+    "index_list": "8",
+    "run": false
+  },
   {
     "category": "medium_range",
     "index_list": "0",

docs/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.py

@@ -0,0 +1,145 @@
+"""
+PointStat: Python embedding to read Argo netCDF files to verify ocean temperature forecast at 50 m depth
+========================================================================================================
+
+model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.conf
+
+"""
+##############################################################################
+# Scientific Objective
+# --------------------
+#
+# This use case utilizes the ASCII2NC tool with python embedding to natively read in Argo
+# netCDF files, a common source of ocean profile data for operational entities. These
+# values are then used by the PointStat tool to verify RTOFS ocean temperature forecast at 50 m depth.
+
+##############################################################################
+# Datasets
+# --------
+#
+# | **Forecast:** RTOFSv2.3 forecast data pre-processed into 0.1 degree lat-lon grid
+#
+# | **Observations:** three netCDF files from Argo
+#
+# | **Climatology:** two monthly climatology files from WOA23
+#
+# | **Sea Ice Mask:** a mask file to exclude forecast grid points with sea ice concentration > 15%
+#
+# | **Location:** All of the input data required for this use case can be found in the
+#   marine_and_cryosphere 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.
+
+##############################################################################
+# METplus Components
+# ------------------
+#
+# This use case calls ASCII2NC to read in Argo netCDF files and then PointStat for
+# verification against RTOFS model data.
+
+##############################################################################
+# METplus Workflow
+# ----------------
+#
+# ASCII2NC is the first tool called. It pulls in three Argo files for the Atlantic,
+# Pacific, and Indian Oceans, respectively using a Python script. These observations are converted into a netCDF
+# file, which is then called by PointStat as the observation dataset. PointStat also pulls
+# in a forecast from the RTOFS for ocean temperature at 50 m depth, which is included in
+# the range of available observation times, and two monthly climatology files from the
+# WOA23 to calculate daily climatology for the valid date. A 24-hour (18Z to 18Z) window is
+# allowed for the observational data, and a “UNIQUE” flag is set to only use the
+# observational data closest to the forecast valid time at a given location. Temperature
+# thresholds are set to correspond to operational usage, and the CTC, CTS, CNT, SL1L2, and
+# SAL1L2 line types are requested.
+# It processes the following run time:
+#
+# | **Valid:** 2023-03-18 00Z
+#
+# | **Forecast lead:** 24 hour
+#
+
+##############################################################################
+# METplus Configuration
+# ---------------------
+#
+# METplus first loads all of the default configuration files found in parm/metplus_config, then it loads any configuration files passed to METplus via the command line with the -c option, i.e. -c parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.conf
+#
+# .. highlight:: bash
+# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.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:`PointStat MET Configuration<point-stat-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/Ascii2NcConfig_wrapped
+#
+# .. highlight:: bash
+# .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped
+
+##############################################################################
+# Python Embedding
+# ----------------
+#
+# This use case uses one Python script to read observation data.
+#
+# parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp/read_argo_metplus.py
+#
+# .. highlight:: python
+# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp/read_argo_metplus.py
+
+##############################################################################
+# 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/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.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 prep and stats/rtofs.20230318 directories (relative to **OUTPUT_BASE**)
+# and will contain the following files:
+#
+# * argo.20230318.nc
+# * point_stat_RTOFS_ARGO_temp_Z50_240000L_20230318_000000V.stat
+
+##############################################################################
+# Keywords
+# --------
+#
+# .. note::
+#
+#   * PointStatToolUseCase
+#   * ASCII2NCToolUseCase
+#   * PythonEmbeddingFileUseCase
+#   * ClimatologyUseCase
+#   * MarineAndCryosphereAppUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
+#
+# sphinx_gallery_thumbnail_path = '_static/marine_and_cryosphere-PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.png'

internal/tests/use_cases/all_use_cases.txt

@@ -86,7 +86,7 @@ Category: marine_and_cryosphere
 6::UserScript_fcstRTOFS_obsAOML_calcTransport::model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.conf:: icecover_env, py_embed
 7::PointStat_fcstGFS_obsNDBC_WaveHeight::model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsNDBC_WaveHeight.conf
 #X::GridStat_fcstRTOFS_obsGHRSST_climWOA_sst::model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.conf, model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst/ci_overrides.conf:: icecover_env, py_embed
-
+8::PointStat_fcstRTOFS_obsARGO_climoWOA23_temp::model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.conf:: py_embed
 
 Category: medium_range
 0::PointStat_fcstGFS_obsNAM_Sfc_MultiField_PrepBufr:: model_applications/medium_range/PointStat_fcstGFS_obsNAM_Sfc_MultiField_PrepBufr.conf

parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp.conf

@@ -0,0 +1,154 @@
+###
+# Purpose: Example METplus configuration file to verify RTOFS ocean temperature
+#          forecasts at 50 m depth with Argo profile data and WOA23 climatology
+#          using python embedding.
+# Contributors: L. Gwen Chen ([email protected]), George McCabe, 
+#               John Halley Gotway, and Daniel Adriaansen
+# Date: 22 March 2023
+###
+
+[config]
+
+###
+# Processes to run
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#process-list
+###
+
+PROCESS_LIST = ASCII2NC,PointStat
+
+###
+# 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
+# LEAD_SEQ is the list of forecast leads to process
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#timing-control
+###
+
+LOOP_BY = VALID
+VALID_TIME_FMT = %Y%m%d
+VALID_BEG = 20230318
+VALID_END = 20230318
+VALID_INCREMENT = 24H
+
+LEAD_SEQ = 024
+
+###
+# File I/O
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
+###
+
+PY_EMBED_SCRIPT = {PARM_BASE}/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp/read_argo_metplus.py
+
+INPUT_FILE = {INPUT_BASE}/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp/argo/atlantic_ocean/{valid?fmt=%Y%m%d}_prof.nc {INPUT_BASE}/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp/argo/indian_ocean/{valid?fmt=%Y%m%d}_prof.nc {INPUT_BASE}/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp/argo/pacific_ocean/{valid?fmt=%Y%m%d}_prof.nc
+
+ASCII2NC_INPUT_DIR =
+ASCII2NC_INPUT_TEMPLATE = "{PY_EMBED_SCRIPT} {INPUT_FILE}"
+
+ASCII2NC_OUTPUT_DIR = {OUTPUT_BASE}/prep
+ASCII2NC_OUTPUT_TEMPLATE = argo.{valid?fmt=%Y%m%d}.nc
+
+ASCII2NC_SKIP_IF_OUTPUT_EXISTS = False
+
+ASCII2NC_FILE_WINDOW_BEGIN = 0
+ASCII2NC_FILE_WINDOW_END = 0
+
+FCST_POINT_STAT_INPUT_DIR = {INPUT_BASE}/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp
+FCST_POINT_STAT_INPUT_TEMPLATE = rtofs.{init?fmt=%Y%m%d}/rtofs_glo_3dz_f{lead?fmt=%3H}_daily_3ztio.argo.nc
+
+OBS_POINT_STAT_INPUT_DIR = {ASCII2NC_OUTPUT_DIR}
+OBS_POINT_STAT_INPUT_TEMPLATE = {ASCII2NC_OUTPUT_TEMPLATE}
+
+POINT_STAT_OUTPUT_DIR = {OUTPUT_BASE}/stats
+POINT_STAT_OUTPUT_TEMPLATE = rtofs.{valid?fmt=%Y%m%d}
+
+###
+# ASCII2NC Settings
+# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#ascii2nc
+###
+
+#ASCII2NC_CONFIG_FILE =
+
+ASCII2NC_WINDOW_BEGIN = 0
+ASCII2NC_WINDOW_END = 0
+
+ASCII2NC_INPUT_FORMAT = python
+
+ASCII2NC_MASK_GRID =
+ASCII2NC_MASK_POLY =
+ASCII2NC_MASK_SID =
+
+ASCII2NC_TIME_SUMMARY_FLAG = False
+ASCII2NC_TIME_SUMMARY_RAW_DATA = False
+ASCII2NC_TIME_SUMMARY_BEG = 000000
+ASCII2NC_TIME_SUMMARY_END = 235959
+ASCII2NC_TIME_SUMMARY_STEP = 300
+ASCII2NC_TIME_SUMMARY_WIDTH = 600
+ASCII2NC_TIME_SUMMARY_GRIB_CODES = 11, 204, 211
+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
+
+###
+# Field Info
+# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#field-info
+###
+
+POINT_STAT_ONCE_PER_FIELD = False
+
+FCST_VAR1_NAME = temperature
+FCST_VAR1_LEVELS = "(0,@50,*,*)"
+FCST_VAR1_OPTIONS = set_attr_lead = "{lead?fmt=%3H}"; set_attr_level = "Z50";
+OBS_VAR1_NAME = TEMP
+OBS_VAR1_LEVELS = Z48-52
+OBS_VAR1_OPTIONS = set_attr_units = "degC";
+BOTH_VAR1_THRESH = >=0, >=26.5
+
+###
+# PointStat Settings
+# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#pointstat
+###
+
+OBS_POINT_STAT_WINDOW_BEGIN = -21600
+OBS_POINT_STAT_WINDOW_END = 64800
+POINT_STAT_MET_CONFIG_OVERRIDES = duplicate_flag = UNIQUE; obs_summary = NEAREST;
+
+POINT_STAT_OFFSETS = 0
+
+MODEL = RTOFS
+OBTYPE = ARGO
+POINT_STAT_DESC = NA
+POINT_STAT_OUTPUT_PREFIX = {MODEL}_{OBTYPE}_temp_Z50
+
+POINT_STAT_REGRID_TO_GRID = NONE
+POINT_STAT_REGRID_METHOD = BILIN
+POINT_STAT_REGRID_WIDTH = 2
+
+POINT_STAT_MESSAGE_TYPE = ARGO
+
+POINT_STAT_MASK_GRID =
+POINT_STAT_MASK_SID =
+POINT_STAT_MASK_POLY = {INPUT_BASE}/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp/rtofs.{init?fmt=%Y%m%d}/mask.global.nc
+
+# Set up climatology files and interpolation methods
+POINT_STAT_CLIMO_MEAN_FILE_NAME = {INPUT_BASE}/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp/woa23/woa23_decav91C0_t03_04.nc, {INPUT_BASE}/model_applications/marine_and_cryosphere/PointStat_fcstRTOFS_obsARGO_climoWOA23_temp/woa23/woa23_decav91C0_t04_04.nc
+POINT_STAT_CLIMO_MEAN_FIELD = {name = "t_an"; level = "(0,@50,*,*)";}
+POINT_STAT_CLIMO_MEAN_REGRID_METHOD = BILIN
+POINT_STAT_CLIMO_MEAN_REGRID_WIDTH = 2
+POINT_STAT_CLIMO_MEAN_REGRID_VLD_THRESH = 0.5
+POINT_STAT_CLIMO_MEAN_REGRID_SHAPE = SQUARE
+POINT_STAT_CLIMO_MEAN_TIME_INTERP_METHOD = DW_MEAN
+POINT_STAT_CLIMO_MEAN_DAY_INTERVAL = 31
+POINT_STAT_CLIMO_MEAN_HOUR_INTERVAL = 6
+
+POINT_STAT_CLIMO_CDF_WRITE_BINS = False
+
+# Set up output files
+POINT_STAT_OUTPUT_FLAG_CTC = STAT
+POINT_STAT_OUTPUT_FLAG_CTS = STAT
+POINT_STAT_OUTPUT_FLAG_CNT = STAT
+POINT_STAT_OUTPUT_FLAG_SL1L2 = STAT
+POINT_STAT_OUTPUT_FLAG_SAL1L2 = STAT