Note
Go to the end to download the full example code
METdbLoad: Basic Use Case
met_tool_wrapper/METdbLoad/METdbLoad.conf
Scientific Objective
Load MET data into a database using the met_db_load.py script found in dtcenter/METdataio
Datasets
METplus Components
This use case utilizes the METplus METdbLoad wrapper to search for files ending with .stat or .tcst, substitute values into an XML load configuration file, and call met_db_load.py to load MET data into a database.
METplus Workflow
METdbLoad is the only tool called in this example. It does not loop over multiple run times:
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/METdbLoad/METdbLoad.conf
[config]
# Documentation for this use case can be found at
# https://metplus.readthedocs.io/en/latest/generated/met_tool_wrapper/METdbLoad/METdbLoad.html
# For additional information, please see the METplus Users Guide.
# https://metplus.readthedocs.io/en/latest/Users_Guide
###
# Processes to run
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#process-list
###
PROCESS_LIST = METDbLoad
###
# Time Info
# LOOP_BY options are INIT, VALID, RETRO, and REALTIME
# If set to INIT or RETRO:
# INIT_TIME_FMT, INIT_BEG, INIT_END, and INIT_INCREMENT must also be set
# If set to VALID or REALTIME:
# VALID_TIME_FMT, VALID_BEG, VALID_END, and VALID_INCREMENT must also be set
# LEAD_SEQ is the list of forecast leads to process
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#timing-control
###
MET_DB_LOAD_RUNTIME_FREQ = RUN_ONCE
LOOP_BY = VALID
VALID_TIME_FMT = %Y%m%d%H
VALID_BEG = 2005080712
VALID_END = 2005080800
VALID_INCREMENT = 12H
###
# File I/O
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
###
MET_DB_LOAD_INPUT_TEMPLATE = {INPUT_BASE}/met_test/out/grid_stat
###
# METdbLoad Settings
# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#metdbload
###
MET_DATA_DB_DIR = {METPLUS_BASE}/../METdataio
MET_DB_LOAD_XML_FILE = {PARM_BASE}/use_cases/met_tool_wrapper/METdbLoad/METdbLoadConfig.xml
MET_DB_LOAD_REMOVE_TMP_XML = True
MET_DB_LOAD_MV_HOST = localhost:3306
MET_DB_LOAD_MV_DATABASE = mv_metplus_test
MET_DB_LOAD_MV_USER = root
MET_DB_LOAD_MV_PASSWORD = mvuser
MET_DB_LOAD_MV_VERBOSE = false
MET_DB_LOAD_MV_INSERT_SIZE = 1
MET_DB_LOAD_MV_MODE_HEADER_DB_CHECK = false
MET_DB_LOAD_MV_DROP_INDEXES = false
MET_DB_LOAD_MV_APPLY_INDEXES = true
MET_DB_LOAD_MV_GROUP = METplus Input Test
MET_DB_LOAD_MV_LOAD_STAT = true
MET_DB_LOAD_MV_LOAD_MODE = false
MET_DB_LOAD_MV_LOAD_MTD = false
MET_DB_LOAD_MV_LOAD_MPR = false
XML Configuration
METplus substitutes values in the template XML configuration file based on user settings in the METplus configuration file. While the XML template may appear to reference environment variables, this is not actually the case. These strings are used as a reference for the wrapper to substitute values.
Note
See the METdbLoad XML Configuration section of the User’s Guide for more information on the values substituted in the file below:
<load_spec>
<connection>
<host>${METPLUS_MV_HOST}</host>
<database>${METPLUS_MV_DATABASE}</database>
<user>${METPLUS_MV_USER}</user>
<password>${METPLUS_MV_PASSWORD}</password>
</connection>
<verbose>${METPLUS_MV_VERBOSE}</verbose>
<insert_size>${METPLUS_MV_INSERT_SIZE}</insert_size>
<mode_header_db_check>${METPLUS_MV_MODE_HEADER_DB_CHECK}</mode_header_db_check>
<drop_indexes>${METPLUS_MV_DROP_INDEXES}</drop_indexes>
<apply_indexes>${METPLUS_MV_APPLY_INDEXES}</apply_indexes>
<group>${METPLUS_MV_GROUP}</group>
<load_stat>${METPLUS_MV_LOAD_STAT}</load_stat>
<load_mode>${METPLUS_MV_LOAD_MODE}</load_mode>
<load_mtd>${METPLUS_MV_LOAD_MTD}</load_mtd>
<load_mpr>${METPLUS_MV_LOAD_MPR}</load_mpr>
<folder_tmpl>{dirs}</folder_tmpl>
<load_val>
<field name="dirs">
${METPLUS_INPUT_PATHS}
</field>
</load_val>
</load_spec>
Running METplus
This use case can be run two ways:
Passing in METdbLoad.conf followed by a user-specific system configuration file:
run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/METdbLoad/METdbLoad.conf -c /path/to/user_system.conf
Modifying the configurations in parm/metplus_config and then passing in METdbLoad.conf:
run_metplus.py -c /path/to/METplus/parm/use_cases/met_tool_wrapper/METdbLoad/METdbLoad.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 to directory 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.
Expected Output
A successful run will output the following both to the screen and to the logfile:
INFO: METplus has successfully finished running.
Keywords
Note
METdbLoadUseCase
AirQualityAndCompAppUseCase
ClimateAppUseCase
ShortRangeAppUseCase
DataAssimilationAppUseCase
EnsembleAppUseCase
MarineAndCryosphereAppUseCase
MediumRangeAppUseCase
PrecipitationAppUseCase
SpaceWeatherAppUseCase
S2SAppUseCase
S2SMJOAppUseCase
S2SMidLatAppUseCase
TCandExtraTCAppUseCase
Navigate to the METplus Quick Search for Use Cases page to discover other similar use cases.
sphinx_gallery_thumbnail_path = ‘_static/met_tool_wrapper-METdbLoad.png’
Total running time of the script: (0 minutes 0.000 seconds)