METplus directory structure
Brief description and overview of the METplus/ directory structure.
- doc/ - Doxygen files for building the html API documentation.
- doc/METplus_Users_Guide - LyX files and the user guide PDF file.
- internal_tests/ - for engineering tests
- parm/ - where config files live
- README.md - general README
- sorc/ - executables and documentation build system
- ush/ - python scripts
METplus default configuration files
The METplus default configuration files metplus_system.conf, metplus_data.conf, metplus_runtime.conf, and metplus_logging.conf are always read by default and in the order shown. Any additional configuration files passed in on the command line are than processed in the order in which they are specified. This allows for each successive conf file the ability to override variables defined in any previously processed conf files. It also allows for defining and setting up conf files from a general (settings used by all use cases, ie. MET install dir) to more specific (Plot type when running track and intensity plotter) structure. The idea is to created a hiearchy of conf files that is easier to maintain, read, and manage. It is important to note, running METplus creates a single configuration file, which can be viewed to understand the result of all the conf file processing.
The final metplus conf file is defined here:
metplus_runtime.conf:METPLUS_CONF={OUTPUT_BASE}/metplus_final.conf
Use this file to see the result of all the conf file processing, this can be very helpful when troubleshooting,
NOTE: The syntax for METplus configuration files MUST include a "[section]" header with the variable names and values on subsequent lines.
Unless otherwise indicated, all directories are relative to your ${METPLUS_PARM_BASE} directory.
The metplus_config directory - there are four config files:
- metplus_system.conf
- contains "[dir]" and "[exe]" to set directory and executable paths
- any information specific to host machine
- metplus_data.conf
- Sample data or Model input location
- filename templates and regex for filenames
- metplus_runtime.conf
- contains "[config]" section
- var lists, stat lists, configurations, process list
- anything else needed at runtime
- metplus_logging.conf
- contains "[dir]" section for setting the location of log files.
- contains "[config]" section for setting various logging configuration options.
The use_cases directory - The use cases:
This is where the use cases you will be running exist. The use case filenaming and directory structure is by convention. It is intended to simplify management of common configuration items for a specific use case. Under the use_cases directory is a subdirectory for each use case. Under that is an examples subdirectory and a more general configuration file that contains information that is shared by examples of the use case.
- For example, the track and intensity use case conf directory and file structure.
- track_and_intensity - directory
- track_and_intensity/track_and_intensity.conf - use case configuration file
- track_and_intensity/examples - directory to hold various track and intensity example conf files.
- track_and_intensity/examples/tcmpr_mean_median.conf - specific use case
- track_and_intensity/examples/README - File containing instructions to run the use case examples in this directory.
Within each use case there is a met_config subdirectory that contains MET specific config files for that use case. The use_cases/<use case>/met_config directory - store all your MET config files, e.g.:
- GridStatConfig_anom (for MET grid_stat)
- TCPairsETCConfig (for MET tc_pairs)
- SeriesAnalysisConfig_by_init (for MET series_analysis)
- SeriesAnalysisConfig_by_lead (for MET series_analysis)
