SMOKE provides the Smkreport tool as a very flexible tool to generate reports on your inventory and emissions modeling case. This program is documented
in detail in Chapter 7, SMOKE Quality Assurance. Here, we provide the information that you need to reconfigure your scripts to use different reporting. The QA_TYPE and QA_LABEL environment variables introduced in Section 4.2.4, “Script settings” are clarified here.
Customize the names of the output report files and Smkreport log files.
The example SMOKE run scripts will name the log files and report output files with preset names. If you set the QA_LABEL setting, the reports and log file names will then include the value of that setting. For example, if the default report name
were a.state.nei99.rpt and QA_LABEL were set to “run1”, the new report name would be a.state.nei99.run1.rpt. The “run1” in QA_LABEL is inserted before the final “rpt” extension.
Select from one of the default settings for QA_TYPE
The default QA_TYPE settings allow users to run Smkreport with the default REPCONFIG files. These files are located in the $OTHERQA_TYPE settings, and each of these settings causes certain reports to be created. Table 4.5, “QA_TYPE settings with associated source categories and default REPCONFIG files” indicates which QA_TYPE setting can be used in which case, and the REPCONFIG files that will be used.
Table 4.5. QA_TYPE settings with associated source categories and default REPCONFIG files
QA_TYPE |
Source Categories | REPCONFIG file from |
||||||||
|---|---|---|---|---|---|---|---|---|---|---|
part1 (RUN_PART1 must be set to Y)
|
|
|
||||||||
part2 (RUN_PART2 must be set to Y)
|
|
|
||||||||
part3 (RUN_PART3 must be set to Y)
|
point | repconfig.pt.elev.txt |
||||||||
part4 (RUN_PART4 must be set to Y)
|
point | repconfig.pt.lfrac.txt |
||||||||
| all |
|
All of the above reports will be generated, provided that the RUN_PART(1-4) settings are set as listed in column 1 of this table.
|
||||||||
| custom |
|
See step (3) below. |
The helper script qa_run.csh is responsible for selecting the correct REPCONFIG file based on the QA_TYPE setting, and these settings need not be changed. If users wish to implement a different configuration, the “custom” value of QA_TYPE should be able to meet those needs without any changes to qa_run.csh. Copying the REPCONFIG files from the example files to your case and changing them changes the default reports that are generated by SMOKE for your
case.
Users can examine these REPCONFIG files along with the documentation in Chapter 7, SMOKE Quality Assurance to determine the reports that will be generated by each. These reports are also generated during the SMOKE installation and
test case run, and can provide examples for understanding which reports will be written.
Using the “custom” setting
If QA_TYPE is set to “custom”, then the qa_run.csh script expects that users will set the correct REPORT* environment variables in the main body of their run script. The REPORT* environment variables are typically used as the logical file names for Smkreport, those environment variables used are themselves configurable in the REPCONFIG file. The physical file names can also be set in the REPCONFIG file directly, instead of relying on the scripts to contain environment variable settings. These options are explained in
greater detail in Chapter 7, SMOKE Quality Assurance.