.. DO NOT EDIT. .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY. .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE: .. "generated/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds.py" .. LINE NUMBERS ARE GIVEN BELOW. .. only:: html .. note:: :class: sphx-glr-download-link-note :ref:`Go to the end ` to download the full example code. .. rst-class:: sphx-glr-example-title .. _sphx_glr_generated_model_applications_marine_and_cryosphere_PointStat_fcstGFS_obsASCAT_satelliteWinds.py: PointStat: read in directory of ASCAT files over user-specified time ==================================================================== model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds.conf .. GENERATED FROM PYTHON SOURCE LINES 9-13 .. contents:: :depth: 1 :local: :backlinks: none .. GENERATED FROM PYTHON SOURCE LINES 15-21 Scientific Objective -------------------- To evaluate wind characteristics (direction, speed, and u/v components) from ASCAT data over water bodies, Python embedding is utilized to pull user-selected variables and time frames from a runtime directory. Those point values are then compared to GFS data over two masked regions over ocean regions. .. GENERATED FROM PYTHON SOURCE LINES 23-27 Version Added ------------- METplus version 6.0 .. GENERATED FROM PYTHON SOURCE LINES 29-47 Datasets -------- **Forecast:** NOAA Global Forecast System (GFS) forecast data for 10-m winds **Observations:** Advanced Scatterometer (ASCAT) from METOP-B provided by NOAA Ocean Prediction Center (OPC) **Climatology:** None **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. .. GENERATED FROM PYTHON SOURCE LINES 49-53 METplus Components ------------------ This use case calls Python Embedding during PointStat, which is the only tool used. .. GENERATED FROM PYTHON SOURCE LINES 55-73 METplus Workflow ---------------- **Beginning time (INIT_BEG):** 202307060000 **End time (INIT_END):** 202307060000 **Increment between beginning and end times (INIT_INCREMENT):** 1M **Sequence of forecast leads to process (LEAD_SEQ):** 6 PointStat kicks off a Python script execution, which reads in the entire directory passed as an arguement. In the script, the directory's files are included only if they are between the times that are also passed as an arguement. After these points are passed back to PointStat as the point observation dataset, they are compared to gridded forecast data in pre-created masking regions. MCTC and MCTS line types are output, using thresholds of relevant wind speeds. The use case processes the following run time: **Init:** 2023-07-06 00Z 6hr lead .. GENERATED FROM PYTHON SOURCE LINES 75-84 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 parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds.conf .. highlight:: bash .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds.conf .. GENERATED FROM PYTHON SOURCE LINES 86-100 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:: PointStatConfig_wrapped .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped .. GENERATED FROM PYTHON SOURCE LINES 102-119 Python Embedding ---------------- This use case calls the read_ASCAT_data.py script to read and pass to PointStat the user-requested variable. The script needs 5 inputs in the following order: a path to a directory that contains only ASCAT data of the "ascat_YYYYMMDDHHMMSS_*" string, a start time in YYYYMMDDHHMMSS, an end time in the same format, a message type to code the variables as (currently set for SATWND), and a variable name to read in. Currently the script puts the same station ID to each observation, but there is space in the code describing an alternate method that may be improved upon to allow different sattellites to have their own station IDs. .. dropdown:: parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds/read_ASCAT_data.py .. highlight:: bash .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds/read_ASCAT_data.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 `_. .. GENERATED FROM PYTHON SOURCE LINES 121-125 User Scripting -------------- User Scripting is not used in this use case. .. GENERATED FROM PYTHON SOURCE LINES 127-136 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_fcstGFS_obsASCAT_satelliteWinds.conf /path/to/user_system.conf See :ref:`running-metplus` for more information. .. GENERATED FROM PYTHON SOURCE LINES 138-152 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/marine_and_cryosphere/PointStat_fcstGFS_obsASCAT_satelliteWinds (relative to **OUTPUT_BASE**) and will contain the following files: * point_stat_060000L_20230706_060000V_mctc.txt * point_stat_060000L_20230706_060000V_mcts.txt * point_stat_060000L_20230706_060000V.stat .. GENERATED FROM PYTHON SOURCE LINES 154-168 Keywords -------- .. note:: * PointStatToolUseCase * PythonEmbeddingFileUseCase * GRIB2FileUseCase * MarineAndCryosphereAppUseCase Navigate to the :ref:`quick-search` page to discover other similar use cases. .. _sphx_glr_download_generated_model_applications_marine_and_cryosphere_PointStat_fcstGFS_obsASCAT_satelliteWinds.py: .. only:: html .. container:: sphx-glr-footer sphx-glr-footer-example .. container:: sphx-glr-download sphx-glr-download-jupyter :download:`Download Jupyter notebook: PointStat_fcstGFS_obsASCAT_satelliteWinds.ipynb ` .. container:: sphx-glr-download sphx-glr-download-python :download:`Download Python source code: PointStat_fcstGFS_obsASCAT_satelliteWinds.py ` .. container:: sphx-glr-download sphx-glr-download-zip :download:`Download zipped: PointStat_fcstGFS_obsASCAT_satelliteWinds.zip ` .. only:: html .. rst-class:: sphx-glr-signature `Gallery generated by Sphinx-Gallery `_