.. DO NOT EDIT. .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY. .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE: .. "generated/model_applications/data_assimilation/StatAnalysis_fcstGFS_HofX_obsIODAv2_PyEmbed.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_data_assimilation_StatAnalysis_fcstGFS_HofX_obsIODAv2_PyEmbed.py: StatAnalysis: IODAv2 ==================== model_applications/data_assimilation/StatAnalysis_fcstGFS_HofX_obsIODAv2_PyEmbed.conf .. GENERATED FROM PYTHON SOURCE LINES 9-13 .. contents:: :depth: 1 :local: :backlinks: none .. GENERATED FROM PYTHON SOURCE LINES 15-35 Scientific Objective -------------------- This use case demonstrates the Stat-Analysis tool and ingestion of HofX NetCDF files that have been output from the Joint Effort for Data assimilation Integration (JEDI) data assimilation system. JEDI uses IODA version 2 formatted files, which are NetCDF files with certain requirements of variables and naming conventions. These files hold observations to be assimilated into forecasts, in this case taken from the JEDI software test data, which contained a small number of Global observation-forecast pairs derived from the hofx application. UFO is a component of HofX, which maps the background forecast to observation space to form O minus B pairs. The HofX application of JEDI takes the input IODAv2 files and adds an additional variable which is the forecast value as interpolated to the observation location. These HofX files are used as input to form Matched Pair (MPR) formatted lists via Python embedding. In this case, Stat-Analysis then performs an aggregate_stat job and outputs statistics in an ascii file. This use case adopts the IODAv2 formatted NetCDF files, which replace the previous variable formatting scheme to make use of NetCDF groups. .. GENERATED FROM PYTHON SOURCE LINES 37-41 Version Added ------------- METplus version 5.0 .. GENERATED FROM PYTHON SOURCE LINES 43-62 Datasets -------- **Forecast:** [UPDATE] **Observation:** [UPDATE] **Climatology:** [UPDATE] **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. **Data source:** JEDI HofX output files in IODAv2 format .. GENERATED FROM PYTHON SOURCE LINES 64-70 METplus Components ------------------ This use case utilizes the METplus StatAnalysis wrapper to search for files that are valid for the given case and generate a command to run the MET tool stat_analysis. .. GENERATED FROM PYTHON SOURCE LINES 72-88 METplus Workflow ---------------- **Beginning time (INIT_BEG):** 2018041500 **End time (INIT_END):** 2018041500 **Increment between beginning and end times (INIT_INCREMENT):** 12H **Sequence of forecast leads to process (LEAD_SEQ):** 0 StatAnalysis is the only tool called in this example. It processes the following run times: | **Valid:** 2018-04-15_00Z | **Forecast lead:** 0 hour .. GENERATED FROM PYTHON SOURCE LINES 90-99 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/data_assimilation/StatAnalysis_fcstGFS_HofX_obsIODAv2_PyEmbed.conf .. highlight:: bash .. literalinclude:: ../../../../parm/use_cases/model_applications/data_assimilation/StatAnalysis_fcstGFS_HofX_obsIODAv2_PyEmbed.conf .. GENERATED FROM PYTHON SOURCE LINES 101-116 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:: STATAnalysisConfig_wrapped .. highlight:: bash .. literalinclude:: ../../../../parm/met_config/STATAnalysisConfig_wrapped .. GENERATED FROM PYTHON SOURCE LINES 118-127 Python Embedding ---------------- This use case uses a Python embedding script to read input data. .. dropdown:: parm/use_cases/model_applications/data_assimilation/StatAnalysis_fcstGFS_HofX_obsIODAv2_PyEmbed/read_iodav2_mpr.py .. highlight:: python .. literalinclude:: ../../../../parm/use_cases/model_applications/data_assimilation/StatAnalysis_fcstGFS_HofX_obsIODAv2_PyEmbed/read_iodav2_mpr.py .. GENERATED FROM PYTHON SOURCE LINES 129-133 User Scripting -------------- This use case does not use additional scripts. .. GENERATED FROM PYTHON SOURCE LINES 135-144 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/StatAnalysis_fcstGFS_HofX_obsIODAv2_PyEmbed.conf /path/to/user_system.conf See :ref:`running-metplus` for more information. .. GENERATED FROM PYTHON SOURCE LINES 146-158 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 {OUTPUT_BASE}/StatAnalysis_IODAv2 and will contain the following file:: * dump.out .. GENERATED FROM PYTHON SOURCE LINES 160-174 Keywords -------- .. note:: * StatAnalysisToolUseCase * PythonEmbeddingFileUseCase * DataAssimilationUseCase * IODA2NCToolUseCase Navigate to the :ref:`quick-search` page to discover other similar use cases. .. _sphx_glr_download_generated_model_applications_data_assimilation_StatAnalysis_fcstGFS_HofX_obsIODAv2_PyEmbed.py: .. only:: html .. container:: sphx-glr-footer sphx-glr-footer-example .. container:: sphx-glr-download sphx-glr-download-jupyter :download:`Download Jupyter notebook: StatAnalysis_fcstGFS_HofX_obsIODAv2_PyEmbed.ipynb ` .. container:: sphx-glr-download sphx-glr-download-python :download:`Download Python source code: StatAnalysis_fcstGFS_HofX_obsIODAv2_PyEmbed.py ` .. container:: sphx-glr-download sphx-glr-download-zip :download:`Download zipped: StatAnalysis_fcstGFS_HofX_obsIODAv2_PyEmbed.zip ` .. only:: html .. rst-class:: sphx-glr-signature `Gallery generated by Sphinx-Gallery `_