""" GridStat: Python Embedding for sea surface salinity using level 3, 8 day mean obs ================================================================================= model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.conf """ ############################################################################## # .. contents:: # :depth: 1 # :local: # :backlinks: none ############################################################################## # Scientific Objective # -------------------- # # This use case utilizes Python embedding to extract several statistics from the sea surface salinity data over the globe, # which was already being done in a closed system. By producing the same output via METplus, this use case # provides standardization and reproducible results. ############################################################################## # Version Added # ------------- # # METplus version 4.1 ############################################################################## # Datasets # -------- # # **Forecast:** NOAA Real-Time Ocean Forecast System (RTOFS) # Sea Surface Salinity (sss) file via Python Embedding script/file # # **Observations:** NASA Soil Moisture Active Passive (SMAP) # Sea Surface Salinity (sss) file via Python Embedding script/file # # **Sea Ice Masking:** NOAA Real-Time Ocean Forecast System (RTOFS) # ice cover file via Python Embedding script/file # # **Climatology:** World Ocean Atlas (WOA) Sea Surface Salinity (sss) # file via Python Embedding script/file # # **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. ############################################################################## # External Dependencies # --------------------- # # You will need to use a version of Python 3.6+ that has the following packages installed: # # * scikit-learn # * pyresample # # If the version of Python used to compile MET did not have these libraries at the time of compilation, you will need to add these packages or create a new Python environment with these packages. # # If this is the case, you will need to set the MET_PYTHON_EXE environment variable to the path of the version of Python you want to use. If you want this version of Python to only apply to this use case, set it in the [user_env_vars] section of a METplus configuration file.: # # [user_env_vars] # MET_PYTHON_EXE = /path/to/python/with/required/packages/bin/python ############################################################################## # METplus Components # ------------------ # # This use case utilizes the METplus GridStat wrapper to generate a # command to run the MET tool GridStat with Python Embedding for the specified user hemispheres ############################################################################## # METplus Workflow # ---------------- # # **Beginning time (VALID_BEG):** 20210502 # # **End time (VALID_END):** 20210502 # # **Increment between beginning and end times (VALID_INCREMENT):** 1M # # **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 ############################################################################## # 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, # i.e. parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.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` # # .. dropdown:: GridStatConfig_wrapped # # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped ############################################################################## # Python Embedding # ---------------- # # This use case uses one Python script to read forecast and observation data. # # .. dropdown:: parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss/read_rtofs_smap_woa.py # # .. highlight:: python # .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss/read_rtofs_smap_woa.py # # For more information on the basic requirements to utilize Python Embedding in METplus, # please refer to the MET User’s Guide section on # `Python embedding `_. ############################################################################## # User Scripting # -------------- # # User Scripting is not used in this use case. ############################################################################## # 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/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.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 thisIce use case will be found in 20210503 (relative to **OUTPUT_BASE**) # and will contain the following files: # # * grid_stat_SSS_000000L_20210502_000000V.stat # * grid_stat_SSS_000000L_20210502_000000V_cnt.txt # * grid_stat_SSS_000000L_20210502_000000V_pairs.nc ############################################################################## # Keywords # -------- # # .. note:: # # * GridStatToolUseCase # * PythonEmbeddingFileUseCase # * MarineAndCryosphereAppUseCase # * ClimatologyUseCase # # Navigate to the :ref:`quick-search` page to discover other similar use cases. # # # # sphinx_gallery_thumbnail_path = '_static/marine_and_cryosphere-GridStat_fcstRTOFS_obsSMAP_climWOA_sss.png'