""" Multi_Tool: Feature Relative by Lead (with lead groupings) ========================================================== model_applicaitons/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf """ ############################################################################## # .. contents:: # :depth: 1 # :local: # :backlinks: none ############################################################################## # Scientific Objective # -------------------- # # By maintaining focus of each evaluation time (or evaluation time series, in this case) # on a user-defined area around a cyclone, the model statistical errors associated # with cyclonic physical features (moisture flux, stability, strength of upper-level # PV anomaly and jet, etc.) can be related directly to the model forecasts and provide # improvement guidance by accurately depicting interactions with significant weather # features around and within the cyclone. This is in contrast to the traditional # method of regional averaging cyclone observations in a fixed grid, which # "smooths out" system features and limits the meaningful metrics that can be gathered. # Specifically, this use case creates bins of forecast lead times as specified by the # given ranges which provides additional insight directly into forecast lead time accuracy. ############################################################################## # Version Added # ------------- # # METplus version 3.0 ############################################################################## # Datasets # -------- # # Relevant information about the datasets that would be beneficial include: # # * TC-Pairs/TC-Stat Forecast dataset: ADeck modified-ATCF tropical cyclone data # * Series-Analysis Forecast dataset: GFS # * TC-Pairs/TC-Stat Observation dataset: BDeck modified-ATCF tropical cyclone data # * Series-Analysis Observation dataset: GFS Analysis # ############################################################################## # External Dependencies # --------------------- # # You will need to use a version of Python 3.6+ that has the following packages installed:: # # * netCDF4 # ############################################################################## # METplus Components # ------------------ # # This use case first runs TCPairs and ExtractTiles wrappers to generate matched # tropical cyclone data and regrid them into appropriately-sized tiles # along a storm track. The MET tc-stat tool is used to filter the # track data, and the MET regrid-dataplane tool is used to regrid the # data (GRIB1 or GRIB2 into netCDF). Next, a series analysis by lead time is # performed on the results and plots (.ps and .png) are generated for all # variable-level-stat combinations from the specified variables, levels, and # requested statistics. The final results are aggregated into forecast hour # groupings as specified by the start, end and increment in the METplus # configuration file, as well as labels to identify each forecast hour grouping. ############################################################################## # METplus Workflow # ---------------- # # The following tools are used for each run time: # # TCPairs > RegridDataPlane, TCStat > SeriesAnalysis # # This example loops by forecast/lead time (with begin, end, and increment as specified in the METplus # TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf file). # The following will be run based on the availability of data corresponding to the initialization time # (in this example, we only have 20141214 as our initialization time) and the requested forecast leads, resulting # in the run times below. # # Run times: # # | **Init:** 20141214_0Z # | **Forecast lead:** 6, 12, 18, 24, 30, 36, 42 # | # ############################################################################## # 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/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.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` 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` # # **TCPairsConfig_wrapped** # # .. note:: See the :ref:`TCPairs MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: # # .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/TCPairsConfig_wrapped # # **TCStatConfig_wrapped** # # .. note:: See the :ref:`TCStat MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: # # .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/TCStatConfig_wrapped # # **SeriesAnalysisConfig_wrapped** # # .. note:: See the :ref:`SeriesAnalysis MET Configuration` section of the User's Guide for more information on the environment variables used in the file below: # # .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped ############################################################################## # Running METplus # --------------- # # This use case can be run two ways: # # 1) Passing in TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf, then a user-specific system configuration file:: # # run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf # -c /path/to/user_system.conf # # 2) Modifying the configurations in parm/metplus_config, then passing in TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.conf:: # # run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.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 # # and for the [exe] section, you will need to define the location of # NON-MET executables. If the executable is in the user's path, METplus will find it from # the name. If the executable is not in the path, specify the full # path to the executable here (i.e. CONVERT = /usr/bin/convert) The following executables are required # for performing series analysis use cases: # # If the executables are in the path: # # * **CONVERT = convert** # # **NOTE:** All of these executable items must be located under the [exe] section. # # # If the executables are not in the path, they need to be defined: # # * **CONVERT = /path/to/convert** # # **NOTE:** All of these executable items must be located under the [exe] section. # 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 # # [exe] # CONVERT = /path/to/convert # # **NOTE:** The INPUT_BASE, OUTPUT_BASE, and MET_INSTALL_DIR must be located under the [dir] section, while the RM, CUT, TR, NCAP2, CONVERT, and NCDUMP must be located under the [exe] 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 series_analysis_lead, relative to the **OUTPUT_BASE**, and in the following directories (relative to **OUTPUT_BASE**): # # * Day1 # * Day2 # * series_animate # # The *Day1* subdirectory will contain files that have the following format: # # ANLY_FILES_Fhhh_to_FHHH # # FCST_ASCII_FILES_Fhhh_to_FHHH # # series___.png # # series___.ps # # series___.nc # # Where: # # **hhh** is the starting forecast hour/lead time in hours # # **HHH** is the ending forecast hour/lead time in hours # # **varname** is the variable of interest, as specified in the METplus series_by_lead_all_fhrs config file # # **level** is the level of interest, as specified in the METplus series_by_lead_all_fhrs config file # # **stat** is the statistic of interest, as specified in the METplus series_by_lead_all_fhrs config file. # # The *Day2* subdirectory will contain files that have the same formatting as *Day1*, but for those forecast hours within 24 to 42 hours. # # | The series_animate directory contains the animations of the series analysis in .gif format for all variable, level, and statistics combinations: # # series_animate___.gif ############################################################################## # Keywords # -------- # # .. note:: # # * MediumRangeAppUseCase # * TCPairsToolUseCase # * SeriesByLeadUseCase # * TCStatToolUseCase # * RegridDataPlaneToolUseCase # * MediumRangeAppUseCase # * SeriesAnalysisUseCase # * GRIB2FileUseCase # * FeatureRelativeUseCase # * SBUOrgUseCase # * DiagnosticsUseCase # * RuntimeFreqUseCase # * TropicalCycloneUseCase # # Navigate to the :ref:`quick-search` page to discover other similar use cases. # # # # sphinx_gallery_thumbnail_path = '_static/medium_range-TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.png' #