SMOKE Log Scanner (Metadata Tool)
This utility scans a set of SMOKE log files and produces an XML metadata document.
Usage
Program archive
Unpack the program archive and confirm that the main program file SMOKE_Log_Scanner.pl is executable.
At the command prompt, type the following:
SMOKE_Log_Scanner.pl <input file> <output file>
<input file> is a text file containing SMOKE log file names with full or relative paths. This file may contain comment lines, provided that the line starts with the # sign.
<output file> is the name of the XML document created by the program. If the output file already exists, the utility will confirm that you wish to overwrite it.
The utility also looks for the environment variable $SMK_BIN to determine the location of the SMOKE executables. If this variable is not set, the location and last modification time of the executables will not be in the output file.
Limitations
- The utility doesn't process biogenics log files, or log files for Grwinven, Mrggrid, Smk2emis, and Smkreport. If log files for these programs are listed in the input file, the utility will print a warning and ignore the log file.
- The utility can only process Smkmerge log files when Smkmerge was used to merge gridded, hourly, and speciated emissions for a single-source category. If these conditions are not met, the utility will print an error message and exit.
- Consistency checks between log files are not fully implemented. For example, the utility does not confirm that all log files correspond to the same episode.
- While the output file is an XML document, it does not have an associated schema and is not self-describing.
- When comparing data files referenced by the logs, the filenames must match exactly. There is no provision for different $SMK_DAT directories.
- Some information is missing from the XML output including modeler details, meteorology data parameters, and I/O API library version.
Example Output
The file nctox_output.txt is an example of the output created by the utility when processing the log files from the nctox modeling case released with SMOKE.