.. DO NOT EDIT. .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY. .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE: .. "generated/met_tool_wrapper/UserScript/UserScript_run_once_per_valid.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_met_tool_wrapper_UserScript_UserScript_run_once_per_valid.py: UserScript: Run Once Per Valid Use Case ======================================= met_tool_wrapper/UserScript/UserScript_run_once_per_valid.conf .. GENERATED FROM PYTHON SOURCE LINES 9-18 Scientific Objective -------------------- Demonstrate how to run a user-defined script that should be executed once for each valid time. This use case runs a simple ls command to list the contents of a directory. A wildcard character (*) is used to replace filename template tags for init and lead to find all files that match any of the times available. .. GENERATED FROM PYTHON SOURCE LINES 20-26 Datasets -------- | **Input:** Empty test files from the METplus repository | .. GENERATED FROM PYTHON SOURCE LINES 28-33 METplus Components ------------------ This use case utilizes the METplus UserScript wrapper to generate a command that is specified by the user. .. GENERATED FROM PYTHON SOURCE LINES 35-46 METplus Workflow ---------------- UserScript is the only tool called in this example. It processes the following run times: | **Valid:** 2014-10-31 09:30:15 | **Valid:** 2014-10-31 21:30:15 | **Valid:** 2014-11-01 09:30:15 | .. GENERATED FROM PYTHON SOURCE LINES 48-57 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/met_tool_wrapper/UserScript/UserScript_run_once_per_valid.conf .. highlight:: bash .. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/UserScript/UserScript_run_once_per_valid.conf .. GENERATED FROM PYTHON SOURCE LINES 59-64 MET Configuration --------------------- None. UserScript does not use configuration files. .. GENERATED FROM PYTHON SOURCE LINES 66-94 Running METplus --------------- This use case can be run two ways: 1) Passing in UserScript_run_once_per_valid.conf_run_once then a user-specific system configuration file:: run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/UserScript/UserScript_run_once_per_valid.conf_run_once -c /path/to/user_system.conf 2) Modifying the configurations in parm/metplus_config, then passing in UserScript_run_once_per_valid.conf:: run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/GridStat/UserScript_run_once_per_valid.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. .. GENERATED FROM PYTHON SOURCE LINES 96-142 Expected Output --------------- A successful run will output the following both to the screen and to the logfile:: INFO: METplus has successfully finished running. No output files are generated from this use case, but the logfile will contain the results of the directory listing command(s) Valid time: 2014-10-31 09:30:15 * init_20141024093015_valid_20141031093015_lead_168.nc * init_20141025093015_valid_20141031093015_lead_144.nc * init_20141026093015_valid_20141031093015_lead_120.nc * init_20141027093015_valid_20141031093015_lead_096.nc * init_20141028093015_valid_20141031093015_lead_072.nc * init_20141029093015_valid_20141031093015_lead_048.nc * init_20141030093015_valid_20141031093015_lead_024.nc * init_20141030213015_valid_20141031093015_lead_012.nc * init_20141031093015_valid_20141031093015_lead_000.nc Valid time: 2014-10-31 21:30:15 * init_20141024213015_valid_20141031213015_lead_168.nc * init_20141025213015_valid_20141031213015_lead_144.nc * init_20141026213015_valid_20141031213015_lead_120.nc * init_20141027213015_valid_20141031213015_lead_096.nc * init_20141028213015_valid_20141031213015_lead_072.nc * init_20141029213015_valid_20141031213015_lead_048.nc * init_20141030213015_valid_20141031213015_lead_024.nc * init_20141031093015_valid_20141031213015_lead_012.nc * init_20141031213015_valid_20141031213015_lead_000.nc Valid time: 2014-11-01 09:30:15 * init_20141025093015_valid_20141101093015_lead_168.nc * init_20141026093015_valid_20141101093015_lead_144.nc * init_20141027093015_valid_20141101093015_lead_120.nc * init_20141028093015_valid_20141101093015_lead_096.nc * init_20141029093015_valid_20141101093015_lead_072.nc * init_20141030093015_valid_20141101093015_lead_048.nc * init_20141031093015_valid_20141101093015_lead_024.nc * init_20141031213015_valid_20141101093015_lead_012.nc * init_20141101093015_valid_20141101093015_lead_000.nc .. GENERATED FROM PYTHON SOURCE LINES 144-154 Keywords -------- .. note:: * UserScriptUseCase * RuntimeFreqUseCase Navigate to the :ref:`quick-search` page to discover other similar use cases. .. _sphx_glr_download_generated_met_tool_wrapper_UserScript_UserScript_run_once_per_valid.py: .. only:: html .. container:: sphx-glr-footer sphx-glr-footer-example .. container:: sphx-glr-download sphx-glr-download-jupyter :download:`Download Jupyter notebook: UserScript_run_once_per_valid.ipynb ` .. container:: sphx-glr-download sphx-glr-download-python :download:`Download Python source code: UserScript_run_once_per_valid.py ` .. container:: sphx-glr-download sphx-glr-download-zip :download:`Download zipped: UserScript_run_once_per_valid.zip ` .. only:: html .. rst-class:: sphx-glr-signature `Gallery generated by Sphinx-Gallery `_