"""
MODE/Grid-Stat: Brightness Temperature Verification and Distance Maps
=========================================================================

model_applications/
short_range/
MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf

"""
##############################################################################
# Scientific Objective
# --------------------
#
# To provide statistical inforation on regions of low brightness temperatures, 
# defined by creating objects, in the FV3 ensemble members compared to GOES satellite. 
# In addition, distance map information is computed for both the model and observation
# using object based brightness temperatures

##############################################################################
# Datasets
# --------
#
#  * Forecast dataset: FV3 Model member data
#  * Observation dataset: GOES Brightness Temperature
#

##############################################################################
# METplus Components
# ------------------
#
# This use case runs MODE to create object statistics on brightness temperatures 
# below 235 K. Then it runs grid_stat to compute neighborhood contingency table
# counts and distance maps for the forecast and observations. 

##############################################################################
# METplus Workflow
# ----------------
#
# The MODE and grid_stat tools are run for each of 2 ensemble members and for each
# time. This example loops by initialization time.  It processes 2 lead times, listed 
# below.
#
# | **Valid:** 2019-05-21_01Z
# | **Forecast lead:** 01
#
# | **Valid:** 2019-05-21_02Z
# | **Forecast lead:** 02

##############################################################################
# METplus Configuration
# ---------------------
#
# METplus first loads all of the 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/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf
#
# .. highlight:: bash
# .. literalinclude:: ../../../../parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.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:`MODE MET Configuration<mode-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/MODEConfig_wrapped
#
# .. 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

##############################################################################
# Running METplus
# ---------------
#
# This use case can be run two ways:
#
# 1) Passing in MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf then a user-specific system configuration file::
#
#        run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf -c /path/to/user_system.conf
#
# 2) Modifying the configurations in parm/metplus_config, then passing in MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf::
#
#        run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf
#
# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly:
#
# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases
# * **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
# ---------------
#
# 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 short_range/brightness_temperature
# (relative to **OUTPUT_BASE**) and will contain the following files:
#
# mode/mode_FV3_core_lsm1_010000L_20190521_010000V_NAA_cts.txt
# mode/mode_FV3_core_lsm1_010000L_20190521_010000V_NAA_obj.nc
# mode/mode_FV3_core_lsm1_010000L_20190521_010000V_NAA_obj.txt
# mode/mode_FV3_core_lsm1_010000L_20190521_010000V_NAA.ps
# mode/mode_FV3_core_lsm1_010000L_20190521_020000V_NAA_cts.txt
# mode/mode_FV3_core_lsm1_010000L_20190521_020000V_NAA_obj.nc
# mode/mode_FV3_core_lsm1_010000L_20190521_020000V_NAA_obj.txt
# mode/mode_FV3_core_lsm1_010000L_20190521_020000V_NAA.ps
# mode/mode_FV3_core_mp1_010000L_20190521_010000V_NAA_cts.txt
# mode/mode_FV3_core_mp1_010000L_20190521_010000V_NAA_obj.nc
# mode/mode_FV3_core_mp1_010000L_20190521_010000V_NAA_obj.txt
# mode/mode_FV3_core_mp1_010000L_20190521_010000V_NAA.ps
# mode/mode_FV3_core_mp1_010000L_20190521_020000V_NAA_cts.txt
# mode/mode_FV3_core_mp1_010000L_20190521_020000V_NAA_obj.nc
# mode/mode_FV3_core_mp1_010000L_20190521_020000V_NAA_obj.txt
# mode/mode_FV3_core_mp1_010000L_20190521_020000V_NAA.ps
# grid_stat_obj/grid_stat_FV3_core_lsm1_000000L_20190521_010000V_dmap.txt
# grid_stat_obj/grid_stat_FV3_core_lsm1_000000L_20190521_010000V_nbrctc.txt
# grid_stat_obj/grid_stat_FV3_core_lsm1_000000L_20190521_010000V_pairs.nc
# grid_stat_obj/grid_stat_FV3_core_lsm1_000000L_20190521_010000V.stat
# grid_stat_obj/grid_stat_FV3_core_lsm1_000000L_20190521_020000V_dmap.txt
# grid_stat_obj/grid_stat_FV3_core_lsm1_000000L_20190521_020000V_nbrctc.txt
# grid_stat_obj/grid_stat_FV3_core_lsm1_000000L_20190521_020000V_pairs.nc
# grid_stat_obj/grid_stat_FV3_core_lsm1_000000L_20190521_020000V.stat
# grid_stat_obj/grid_stat_FV3_core_mp1_000000L_20190521_010000V_dmap.txt
# grid_stat_obj/grid_stat_FV3_core_mp1_000000L_20190521_010000V_nbrctc.txt
# grid_stat_obj/grid_stat_FV3_core_mp1_000000L_20190521_010000V_pairs.nc
# grid_stat_obj/grid_stat_FV3_core_mp1_000000L_20190521_010000V.stat
# grid_stat_obj/grid_stat_FV3_core_mp1_000000L_20190521_020000V_dmap.txt
# grid_stat_obj/grid_stat_FV3_core_mp1_000000L_20190521_020000V_nbrctc.txt
# grid_stat_obj/grid_stat_FV3_core_mp1_000000L_20190521_020000V_pairs.nc
# grid_stat_obj/grid_stat_FV3_core_mp1_000000L_20190521_020000V.stat


##############################################################################
# Keywords
# --------
#
# .. note::
#
#   * MODEToolUseCase
#   * GridStatToolUseCase
#   * ShortRangeAppUseCase
#   * NetCDFFileUseCase
#   * NOAAEMCOrgUseCase 
#   * NOAAHWTOrgUseCase 
#   * ValidationUseCase 
#
#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
#
#
#
# sphinx_gallery_thumbnail_path = '_static/short_range-MODE_fcstFV3_obsGOES_BrightnessTempObjs.png'
#
