Feature 2188 use case panda c

.github/parm/use_case_groups.json

@@ -11,7 +11,7 @@
   },
   {
     "category": "air_quality_and_comp",
-    "index_list": "0",
+    "index_list": "0-6",
     "run": false
   },
   {

docs/use_cases/model_applications/air_quality_and_comp/GridStat_fcstGFS_obsERA5_lowAndTotalCloudFrac.py

@@ -0,0 +1,138 @@
+"""
+GridStat: Cloud Fractions with Neighborhood and Probabilities
+=============================================================
+
+model_applications/air_quality_and_comp/GridStat_fcstGFS_obsERA5_lowAndTotalCloudFrac.conf
+
+"""
+##############################################################################
+# Scientific Objective
+# --------------------
+#
+# This use case captures various statistical measures of two model comparisons
+# for low and total cloud fractions with different neighborhood
+# settings for internal model metrics and to aid in future model updates
+# 
+
+##############################################################################
+# Datasets
+# --------
+#
+# | **Forecast:** Global Forecast System (GFS)
+# | **Observations:** ECMWF Reanalysis, Version 5 (ERA5)
+# | **Grid:** GPP 17km masking region
+#
+# | **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.
+#
+
+##############################################################################
+# METplus Components
+# ------------------
+#
+# This use case utilizes Python Embedding, which is called using the PYTHON_NUMPY keyword 
+# in the observation input template settings. The same Python script can processes both forecast and
+# observation datasets, but only the observation dataset is not
+# set up for native ingest by MET. Two separate forecast fields are verified against two respective observation fields,
+# with the Python script being passed the input file, the model name, the variable name being analyzed,
+# the initialization and valid times, and a flag to indicate if the field passed is observation or forecast.
+# This process is repeated with 3 instance names to GridStat, each with a different setting for regridding,
+# neighborhood evaluation, thresholding, output line types, and output prefix names.
+
+##############################################################################
+# METplus Workflow
+# ----------------
+#
+# GridStat is the only MET tool called in this example.
+# It processes the following run time:
+#
+# | **Init:** 2022-07-03 12Z
+# | **Forecast lead:** 36 hour
+#
+# Because instance names are used, GridStat will run 3 times for this 1 initalization time.
+
+##############################################################################
+# 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/model_applications/air_quality_and_comp/GridStat_fcstGFS_obsERA5_lowAndTotalCloudFrac.conf
+#
+# .. highlight:: bash
+# .. literalinclude:: ../../../../parm/use_cases/model_applications/air_quality_and_comp/GridStat_fcstGFS_obsERA5_lowAndTotalCloudFrac.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:`GridStat MET Configuration<grid-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/GridStatConfig_wrapped
+
+##############################################################################
+# Python Embedding
+# ----------------
+#
+# This use case utilizes 1 Python script to read and process the observation fields.
+# parm/use_cases/model_applications/air_quality_and_comp/GridStat_fcstGFS_obsERA5_lowAndTotalCloudFrac/read_input_data.py
+#
+# .. highlight:: bash
+# .. literalinclude:: ../../../../parm/use_cases/model_applications/air_quality_and_comp/GridStat_fcstGFS_obsERA5_lowAndTotalCloudFrac/read_input_data.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/air_quality_and_comp/GridStat_fcstGFS_obsERA5_lowAndTotalCloudFrac.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 model_applications/air_quality_and_comp/GridStat_fcstGFS_obsERA5_lowAndTotalCloudFrac
+# (relative to **OUTPUT_BASE**)
+# and will contain the following files:
+#
+# * grid_stat_GFS_to_ERA5_F36_CloudFracs_360000L_20220705_000000V_pairs.nc
+# * grid_stat_GFS_to_ERA5_F36_CloudFracs_360000L_20220705_000000V.stat
+# * grid_stat_GFS_to_ERA5_F36_CloudFracs_NBR_360000L_20220705_000000V_pairs.nc
+# * grid_stat_GFS_to_ERA5_F36_CloudFracs_NBR_360000L_20220705_000000V.stat
+# * grid_stat_GFS_to_ERA5_F36_CloudFracs_PROB_360000L_20220705_000000V_pairs.nc
+# * grid_stat_GFS_to_ERA5_F36_CloudFracs_PRB_360000L_20220705_000000V.stat
+
+
+##############################################################################
+# Keywords
+# --------
+#
+# .. note::
+#
+#   * GridStatToolUseCase
+#   * NetCDFFileUseCase
+#   * AirQualityAndCompAppUseCase
+#   * PythonEmbeddingFileUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+# sphinx_gallery_thumbnail_path = '_static/air_quality_and_comp-GridStat_fcstGFS_obsERA5_lowAndTotalCloudFrac.png'
+#

docs/use_cases/model_applications/air_quality_and_comp/GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac.py

@@ -0,0 +1,138 @@
+"""
+GridStat: Cloud Fractions with Neighborhood and Probabilities
+=============================================================
+
+model_applications/air_quality_and_comp/GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac.conf
+
+"""
+##############################################################################
+# Scientific Objective
+# --------------------
+#
+# This use case captures various statistical measures of two model comparisons
+# for low and total cloud fraction with different neighborhood and probability
+# settings for internal model metrics and to aid in future model updates
+# 
+
+##############################################################################
+# Datasets
+# --------
+#
+# | **Forecast:** Global Forecast System (GFS)
+# | **Observations:** Modern-Era Retrospective analysis for Research and Applications, Version 2 (MERRA2)
+# | **Grid:** GPP 17km masking region
+#
+# | **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.
+#
+
+##############################################################################
+# METplus Components
+# ------------------
+#
+# This use case utilizes Python Embedding, which is called using the PYTHON_NUMPY keyword 
+# in the observation input template settings. The same Python script processes both forecast and
+# observation datasets, but only the observation dataset is not set up for native ingest by MET. 
+# Two separate forecast fields are verified against two respective observation fields,
+# with the Python script being passed the input file, the model name, the variable name being analyzed,
+# the initialization and valid times, and a flag to indicate if the field passed is observation or forecast.
+# This process is repeated with 3 instance names to GridStat, each with a different setting for regridding,
+# neighborhood evaluation, thresholding, output line types, and output prefix names.
+
+##############################################################################
+# METplus Workflow
+# ----------------
+#
+# GridStat is the only MET tool called in this example.
+# It processes the following run time:
+#
+# | **Init:** 2021-07-03 12Z
+# | **Forecast lead:** 36 hour
+# 
+# Because instance names are used, GridStat will run 3 times for this 1 initalization time.
+
+##############################################################################
+# 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/model_applications/air_quality_and_comp/GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac.conf
+#
+# .. highlight:: bash
+# .. literalinclude:: ../../../../parm/use_cases/model_applications/air_quality_and_comp/GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac.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:`GridStat MET Configuration<grid-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/GridStatConfig_wrapped
+
+##############################################################################
+# Python Embedding
+# ----------------
+#
+# This use case utilizes 1 Python script to read and process both forecast and
+# observation fields.
+# parm/use_cases/model_applications/air_quality_and_comp/GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac/read_input_data.py
+#
+# .. highlight:: bash
+# .. literalinclude:: ../../../../parm/use_cases/model_applications/air_quality_and_comp/GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac/read_input_data.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/air_quality_and_comp/GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac.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 model_applications/air_quality_and_comp/GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac
+# (relative to **OUTPUT_BASE**)
+# and will contain the following files:
+#
+# * grid_stat_GFS_TO_MERRA2_F36_CloudFracs_360000L_20210705_000000V_pairs.nc
+# * grid_stat_GFS_to_MERRA2_F36_CloudFracs_360000L_20210705_000000V.stat
+# * grid_stat_GFS_to_MERRA2_F36_CloudFracs_NBR_360000L_20210705_000000V_pairs.nc
+# * grid_stat_GFS_to_MERRA2_F36_CloudFracs_NBR_360000L_20210705_000000V.stat
+# * grid_stat_GFS_to_MERRA2_F36_CloudFracs_PROB_360000L_20210705_000000V_pairs.nc
+# * grid_stat_GFS_to_MERRA2_F36_CloudFracs_PROB_360000L_20210705_000000V.stat
+
+##############################################################################
+# Keywords
+# --------
+#
+# .. note::
+#
+#   * GridStatToolUseCase
+#   * NetCDFFileUseCase
+#   * AirQualityAndCompAppUseCase
+#   * PythonEmbeddingFileUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+# sphinx_gallery_thumbnail_path = '_static/air_quality_and_comp-GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac.png'
+#