This chapter contains format information for all input files used by SMOKE. Chapter 9, SMOKE Intermediate Files and Chapter 10, SMOKE Output Files provide documentation on SMOKE’s intermediate and output file formats.
In this overview section, we first provide a few important notes about file formats (Section 8.1.1, “General notes about file formats”, and then discuss where to put SMOKE input files (Section 8.1.2, “Where to put SMOKE input files”). Section 8.1.3, “SMOKE input file list” summarizes all the input files needed by SMOKE, organized by function. Section 8.1.4, “Input files for SMOKE nctox case” provides a list, organized by SMOKE program, of all the example input files provided with the nctox test case, which is described in Section 4.2.1, “nctox case”.The remaining sections in this chapter are broken down as follows:
Inventory files used by Smkinven and Rawbio (Section 8.2, “Inventory Files”)
Temporal allocation files used by Temporal (Section 8.3, “Temporal Allocation Files”)
Spatial allocation files used by Grdmat, Rawbio, Normbeis3, and Smkmerge (Section 8.4, “Spatial Allocation Files”)
Chemical speciation files used by Spcmat (Section 8.5, “Chemical speciation”)
Growth and controls files used by Cntlmat (Section 8.6, “Growth and Controls Files”)
Special merging files used by Mrggrid (Section 8.7, “Special Merging Files”)
Meteorology files used by Tmpbio, Tmpbeis3, Premobl, and Laypoint (Section 8.8, “Meteorology Files”)
Source-specific files for biogenics, mobile, and point source processing (Section 8.9, “Source-Specific files”)
Support files used by various programs (Section 8.10, “Other Support Files”)
In the tables used to describe the file format for each file, the “Position” column lists either letters or numbers.
When there are letters in the “Position” column, this indicates that the file must be list-directed, and therefore the fields on each line need to be delimited by a space, comma, or semicolon. If there are fields that have embedded spaces, commas, or semicolons in a list-directed file, these entries must be surrounded by single or double quotation marks to prevent SMOKE from treating those characters as delimiters.
When there are numbers in the “Position” column, this indicates that the file is column-specific, which means that the entry must be placed exactly within the columns listed.
For all cross-reference files (e.g. AGREF
, MGREF
, GSREF
), all of the source-characteristic fields are optional. For example, it is permissible to provide only the SCC for use in
matching a profile to a source.
For list-directed files, if there are source characteristic fields that will not be used (such as country/state/county code) that come before the required fields in the file, these must be filled in with a zero or -9. If there are unused fields that come after the required fields in the file, they can be left blank.
For column-specific formats, the optional entries can be left blank or set to -9 when they are not used.
Nearly all input files support full-line and trailing comments. If the first character on a line is a pound sign (#) then the line is treated as a comment. Any characters after an exclamation point (!) are treated as a comment.
A common difficulty for new users is determining where to put the input files for their case. In SMOKE v2.0 and later, we
have reduced the number of places in which you need to keep your raw input files. Section 8.1.4, “Input files for SMOKE nctox case” lists the all of the input directories for the files used in the example “nctox” case. In that section, we also define the path names relative to the
directory, which is the directory in which you install SMOKE (and is different for every installation). In Chapter 3, SMOKE Directories and Example Data, we provide diagrams of the SMOKE directory structures, which help in visualizing the tree of directories that SMOKE uses.
Additionally, Section 4.5, “How to use SMOKE” contains instructions for getting set up for new runs, including the files that need to be created and where they should
go.
SMK_HOME
In summary, SMOKE input files must go into a handful of directories (see Section 8.1.4, “Input files for SMOKE nctox case”). Multiple directories are needed because in some cases (such as speciation profiles and meteorology data), the data are to be shared across multiple runs. In other cases (such as inventory data), the data are specific to a case and should be stored independently to prevent corrupting other modeling runs. To change the directories used for input (or any other) files in SMOKE, you must modify the Assigns file as described in Section 3.3, “How to change the default directory structure”.
In this section, we list all of the raw input files to SMOKE. The files are grouped into tables by functional type:
Within each table, the files are listed in alphabetical order. When a file is optional, this is noted in the description column of the table.
Table 8.1. Inventory File Locations
Logical File Name | Program | Source Category | File Description | Location |
---|---|---|---|---|
ARINV |
Smkinven | A | Stationary area/nonpoint or nonroad raw inventory in IDA format, SMOKE list format for EMS-95 files, or SMOKE ORL format | $ARDAT |
BCUSE |
Rawbio | B | Biogenic county land use data | $GE_DAT |
BGUSE |
Rawbio | B | Biogenic gridded land use data | $BGDAT |
MBINV |
Smkinven | M | Mobile source raw inventory in IDA format for nonlink data, SMOKE list format for EMS-95 nonlink and link data, or SMOKE ORL format | $MBDAT |
PTDAY |
Smkinven | P | Point source raw day-specific inventory data (optional) | $PTDAT |
PTHOUR |
Smkinven | P | Point source raw hour-specific inventory data (optional) | $PTDAT |
PTINV |
Smkinven | P | Point source raw inventory in IDA format, SMOKE list format for EMS-95 files, or SMOKE ORL format | $PTDAT |
VMTMIX |
Smkinven | M | Mobile source vehicle mix for EMS-95 files | $MBDAT |
Table 8.2. Temporal Allocation Input File Locations
Logical File Name | Program | Source Category | File Description | Location |
---|---|---|---|---|
[A|M|P]TPRO |
Temporal | A, M, P | Temporal profile file | $GE_DAT |
[A|M|P]TREF |
Temporal | A, M, P | Temporal cross-reference file | $GE_DAT |
HOLIDAYS |
Temporal | A, M, P | Holidays file | $GE_DAT |
PROCDATES |
Temporal | A, M, P | Procdates file | $GE_DAT |
Table 8.3. Spatial Allocation Input File Locations
Logical File Name | Program | Source Category | File Description | Location |
---|---|---|---|---|
SRGDESC |
Grdmat | A, M | Surrogate definitions and descriptions | $GE_DAT |
Area/Mobile surrogate profiles |
Grdmat, Surgtool | A, M | Area and/or mobile source spatial surrogates | $SRGPRO_PATH |
[A|M]GREF |
Grdmat | A, M | Area source or mobile gridding cross-reference | $GE_DAT |
BELD3_A , BELD3_B , BELD3_TOT |
Beld3to2, Normbeis3 | B | Biogenic gridded landuse for use in SMOKE-BEIS3 | $BGDAT |
BGPRO |
Rawbio, Smkmerge | B | Biogenic spatial surrogates for county land use | $GE_DAT |
GRIDDESC |
A, B, M, P | Grid descriptions | $GE_DAT |
Table 8.4. Chemical Speciation Input File Locations
Logical File Name | Program | Source Category | File Description | Location |
---|---|---|---|---|
GSCNV |
Spcmat | A, M, P | Pollutant-to-pollutant conversion file (e.g., ROG to TOG) (optional) | $GE_DAT |
GSPRO |
Cntlmat, Spcmat, Tmpbio, Tmpbeis3 | A, B, M, P | Speciation profiles file | $GE_DAT |
GSREF |
Spcmat | A, M, P | Speciation cross-reference file (a.k.a., mapping table) | $GE_DAT |
Table 8.5. Growth and Controls Input File Locations
Logical File Name | Program | Source Category | File Description | Location |
---|---|---|---|---|
GCNTL |
Cntlmat, Pktreduc | A, M, P | Control packets or growth packets file | $STATIC |
Table 8.6. Special Merging Input File Locations
Logical File Name | Program | Source Category | File Description | Location |
---|---|---|---|---|
FILELIST |
Mrggrid | A, B, M, P | List of gridded 2-D and/or 3-D files to be merged |
|
Table 8.7. Meteorology Input File Locations
Logical File Name | Program | Source Category | File Description | Location |
---|---|---|---|---|
GRID_CRO_2D |
Tmpbio, Tmpbeis3 | B | Grid 2-D cross-point file (optional) | $METDAT |
GRID_CRO_3D |
Laypoint | P | Grid 3-D cross-point file | $METDAT |
MET_CRO_2D |
Tmpbio, Tmpbeis3, Premobl, Laypoint, Metscan | B, M, P | Meteorology 2-D cross-point file | $METDAT |
MET_CRO_3D |
Tmpbio, Tmpbeis3, Premobl, Laypoint, Metscan | B, M, P | Meteorology 3-D cross-point file (optional for biogenics) | $METDAT |
MET_DOT_3D |
Laypoint | P | Meteorology 3-D dot-point file | $METDAT |
METLIST |
Tmpbio, Premobl | B, M | Listing of meteorology files | $STATIC |
RADLIST |
Tmpbio | B | Listing of meteorology files containing radiation data | $STATIC |
Table 8.8. Biogenic-Specific Input File Locations
Logical File Name | Program | Source Category | File Description | Location |
---|---|---|---|---|
B3FAC |
Normbeis3 | B | BEIS3 emissions factors | $BGDAT |
B3XRF |
Beld3to2 | B | BELD3 to BELD2 cross-reference file | $GE_DAT |
BFAC |
Rawbio | B | Summer or winter biogenic emission factors | $GE_DAT |
BIOSEASON |
Tmpbeis3, Tmpbio | B | Bioseason switch file | $GE_DAT |
Table 8.9. Mobile-Specific Input File Locations
Logical File Name | Program | Source Category | File Description | Location |
---|---|---|---|---|
M6LIST |
Emisfac | M | List of MOBILE6 input scenarios | $MBDAT |
M6MAP |
Emisfac | M | MOBILE6 vehicle type mapping file | $MBDAT |
MCODES |
Smkinven, Grdmat, Spcmat, Temporal | M | Mobile vehicle type and road codes | $MBDAT |
MCREF |
Mbsetup | M | Mobile source county cross-reference | $MBDAT |
MEFLIST |
Temporal | M | List of emission factor files | $SMK_EMISPATH |
MEPROC |
Emisfac, Spcmat, Temporal | M | Mobile emission processes (e.g., exhaust, running loss, refueling) with associated activities and pollutants | $MBDAT |
MVREF |
Mbsetup | M | Mobile source county settings file | $MBDAT |
SPDPRO |
Emisfac | M | Hourly speed profiles | $MBDAT |
SPDREF |
Mbsetup | M | Hourly speed cross-reference | $MBDAT |
Table 8.10. Point-Specific Input File Locations
Logical File Name | Program | Source Category | File Description | Location |
---|---|---|---|---|
PELVCONFIG |
Elevpoint | P | Elevated source and PinG selection configuration file | $PTDAT |
PSTK |
Smkinven | P | Replacement stack parameters for invalid stacks | $GE_DAT |
PTMPLIST |
Elevpoint | P | List of PTMP files for Elevpoint to use to compute maximum daily emissions
|
$PTDAT |
Table 8.11. Other Support Input File Locations
Logical File Name | Program | Source Category | File Description | Location |
---|---|---|---|---|
ARTOPNT |
Smkinven | A | Area-to-point conversion file |
|
COSTCY |
Smkinven, Grwinven, Temporal, Smkmerge, Smkreport | A, B, M, P | Country, state, and county names and time zones | $GE_DAT |
INVTABLE |
Smkinven, Emisfac, Spcmat, Temporal, Smkmerge | A, M, P | Pollutant and activity names and codes in order of output |
|
MACTDESC |
Smkreport | A, P | MACT descriptions | $GE_DAT |
NAICSDESC |
Smkreport | A, P | NAICS descriptions | $GE_DAT |
NHAPEXCLUDE |
Smkinven | A, M, P | NONHAP exclusions file |
|
ORISDESC |
Smkinven | P | ORIS facility descriptions, needed for getting ORIS facility names for reporting purposes | $GE_DAT |
SCCDESC |
Smkinven, Smkreport | A, M, P | SCC descriptions | $GE_DAT |
SICDESC |
Smkreport | A, P | SIC descriptions | $GE_DAT |
VNAMMAP |
Smk2emis | A, B, M, P | Species name mapping file for Smk2emis | $GE_DAT |
In this section, we summarize the SMOKE input files for the nctox example case provided with SMOKE for processing ozone, PM, and toxics pollutants. You can adapt these tables to keep track of the raw input files needed for your cases, and to help you understand all the files that need to be prepared for input to SMOKE. Section 4.2.1, “nctox case” is a description of the nctox case in more detail. The documentation in Section 4.5, “How to use SMOKE” describes which input files need to be changed for adapting the test case scripts to a particular case.
We list the raw SMOKE input files by program, with the programs listed in alphabetical order:
Intermediate files (those output by one program and input to another) are not included in the list, but can be found with the program-specific documentation in Chapter 6, SMOKE Core Programs and in the intermediate file documentation in Chapter 9, SMOKE Intermediate Files. The files that are shared among several programs are listed with each program for which they are used (i.e. listed multiple times), and noted with an asterisk adjacent to the logical file name. The file paths are listed using the path logical names, the definitions for which are available below the tables.
Table 8.12. Cntlmat input files for nctox case
Logical file name and description | Source category | Path | Physical file name | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GCNTL : growth and/or control instructions
|
|
|
|
Table 8.13. Elevpoint input files for nctox case
Logical file name and description | Source category | Path | Physical file name |
---|---|---|---|
GRIDDESC *: grid descriptions
|
P |
|
GRIDDESC |
PELVCONFIG : elevated source selection instructions
|
P | $PTDAT |
pelvconfig.top50.txt |
PTMPLIST : optional list of PTMP SMOKE intermediate files for selecting elevated point sources based on emissions
|
P | $PTDAT |
ptmplist.txt (generated automatically by run script)
|
* This file is used by more than one program. |
Table 8.14. Emisfac input files for nctox case
Logical file name and description | Source category | Path | Physical file name | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
INVTABLE *: inventory table
|
M |
|
invtable_onroad.cb4.010804.txt |
||||||||||||
M6LIST : List of MOBILE6 scenario files with path
|
M | $MBDAT |
m6list.nctox.1999.txt (generated automatically by run script)
|
||||||||||||
MEPROC *: mobile processes
|
M |
|
meproc.txt |
||||||||||||
Required MOBILE6 input files. (Note that there are other MOBILE6 input files that are needed if you use certain settings in
the M6LIST file).
|
M |
|
|
||||||||||||
* This file is used by more than one program. |
Table 8.15. Grdmat input files for nctox case
Logical file name and description | Source category | Path | Physical file name |
---|---|---|---|
Area gridding surrogates | A |
|
amgpro.12km_041604.nc.txt |
AGREF : gridding cross-reference
|
A |
|
amgref_us_051704.txt |
GRIDDESC *: grid descriptions
|
A, M, P |
|
GRIDDESC |
MCODES *: mobile code definitions
|
M | $MBDAT |
mcodes.txt |
Mobile gridding surrogates | M |
|
amgref.m3.us+can+mex.txt |
MGREF : gridding cross-reference
|
M |
|
amgref_us_051704.txt |
* This file is used by more than one program. |
Table 8.16. Grwinven input files for nctox case
Logical file name and description | Source category | Path | Physical file name |
---|---|---|---|
COSTCY *: country, state, and county names
|
A, M, P |
|
costcy.txt |
* This file is used by more than one program. |
Table 8.17. Laypoint input files for nctox case
Logical file name and description | Source category | Path | Physical file name | ||
---|---|---|---|---|---|
GRID_CRO_3D : 3-d cross-point grid data
|
P |
|
GRIDCRO3D |
||
GRIDDESC *: grid descriptions
|
P |
|
GRIDDESC |
||
MET_CRO_2D *: 2-d cross-point meteorology data
|
P |
|
|
||
MET_CRO_3D *: 3-d cross-point grid data
|
P |
|
|
||
MET_DOT_3D : 3-d dot-point grid data (for winds)
|
P |
|
|
||
* This file is used by more than one program. |
Table 8.18. Mbsetup input files for nctox case
Logical file name and description | Source category | Path | Physical file name |
---|---|---|---|
MCREF : county cross-reference
|
M | $MBDAT |
mcref.nctox.txt |
MVREF : county meteorology group settings
|
M | $MBDAT |
mvref.nctox.txt |
* This file is used by more than one program. |
Table 8.19. Mrggrid input files for nctox case
Logical file name and description | Source category | Path | Physical file name |
---|---|---|---|
FILELIST : list of logical file names to merge
|
All |
|
filelist.mrggrid.txt (generated automatically by run script)
|
Table 8.20. Normbeis3 input files for nctox case
Logical file name and description | Source category | Path | Physical file name |
---|---|---|---|
B3FAC : BEIS3 emissions factors
|
B |
|
b3fac.beis3_efac_v0.98.txt |
BELD3_A : File A of biogenic gridded landuse
|
B | $BGDAT |
beld3.US12NC_66X52.output_a.ncf |
BELD3_B : File B of biogenic gridded landuse
|
B | $BGDAT |
beld3.US12NC_66X52.output_b.ncf |
BELD3_TOT : Landuse totals
|
B | $BGDAT |
beld3.US12NC_66X52.output_tot.ncf |
Table 8.21. Premobl input files for nctox case
Logical file name and description | Source category | Path | Physical file name |
---|---|---|---|
METLIST : meteorology file list
|
M | $MBDAT |
metlist.premobl.txt (This list will include the paths of the METCOMBO meteorology files for the entire modeling episode and is generated automatically by the run script.)
|
Table 8.22. Smkinven input files for nctox case
Logical file name and description | Source category | Path | Physical file name | ||||
---|---|---|---|---|---|---|---|
ARINV (area): stationary area/nonpoint inventory (or list of inventories)
|
A | $ARDAT |
arinv.stationary.lst |
||||
ARINV (nonroad): nonroad inventory (or list of inventories)
|
A | $NRDAT |
arinv.nonroad.lst |
||||
ARTOPNT : area-to-point assignments
|
A |
|
ar2pt_14OCT03_1999.txt |
||||
COSTCY *: time zones by county
|
All |
|
costcy.txt |
||||
INVTABLE *: inventory table
|
|
|
|
||||
MBINV : on-road mobile inventory (or list of inventories)
|
M | $MBDAT |
mbinv.lst |
||||
MCODES *: mobile code definitions
|
M |
|
mcodes.txt |
||||
NHAPEXCLUDE : exclusions from NONHAP calculation
|
|
|
|
||||
ORISDESC : ORIS ID descriptions
|
P |
|
oris_info.txt |
||||
PTINV : point source inventory (or list of inventories)
|
P | $PTDAT |
ptinv.lst |
||||
PSTK : replacements for invalid stack parameters
|
P |
|
pstk.m3.txt |
||||
SCCDESC : SCC descriptions
|
A, M, P |
|
scc_desc.txt |
||||
* This file is used by more than one program. |
Table 8.23. Smkmerge input files for nctox case
Logical file name and description | Source category | Path | Physical file name | ||||
---|---|---|---|---|---|---|---|
BGPRO : spatial surrogates with land-area surrogate
|
B |
|
bgpro.12km_041604.nc.txt |
||||
GRIDDESC *: grid descriptions
|
All |
|
GRIDDESC |
||||
INVTABLE *: inventory table
|
|
|
|
||||
* This file is used by more than one program. |
Table 8.24. Spcmat input files for nctox case
Logical file name and description | Source category | Path | Physical file name | ||||
---|---|---|---|---|---|---|---|
GSCNV : pollutant-to-pollutant conversion
|
A, M, P |
|
gscnv.txt |
||||
GSPRO *: speciation profiles
|
|
|
|
||||
GSREF : speciation cross-reference
|
A, M, P |
|
gsref.cmaq.cb4p25_wtox.txt |
||||
INVTABLE *: inventory table
|
|
|
|
||||
MCODES *: mobile code definitions
|
M |
|
mcodes.txt |
||||
MEPROC *: mobile processes
|
M |
|
meproc.txt |
||||
* This file is used by more than one program. |
Table 8.25. Temporal input files for nctox case
Logical file name and description | Source category | Path | Physical file name | ||||
---|---|---|---|---|---|---|---|
ATPRO : Temporal profiles
|
A |
|
amptpro.m3.us+can.txt |
||||
ATREF : Temporal cross-reference
|
A |
|
amptref.m3.us+can.txt |
||||
COSTCY *: Daylight time exemptions
|
All |
|
costcy.txt |
||||
HOLIDAYS : Holidays date list
|
A, M, P |
|
holidays.txt |
||||
PROCDATES : Specifc dates to process
|
A, M, P |
|
procdates.txt |
||||
INVTABLE *: inventory table
|
|
|
|
||||
MCODES *: mobile code definitions
|
M |
|
mcodes.txt |
||||
MEFLIST : list of emission factors files
|
M |
|
meflist.txt (generated automatically by run script)
|
||||
MEPROC *: mobile processes
|
M |
|
meproc.txt |
||||
MTPRO : Temporal profiles
|
M |
|
amptpro.m3.us+can.txt |
||||
MTREF : Temporal cross-reference
|
M |
|
amptref.m3.us+can.txt |
||||
PTPRO : Temporal profiles
|
P |
|
amptpro.m3.us+can.txt |
||||
PTREF : Temporal cross-reference
|
P |
|
amptref.m3.us+can.txt |
||||
* This file is used by more than one program. |
Table 8.26. Tmpbeis3 input files for nctox case
Logical file name and description | Source category | Path | Physical file name | ||
---|---|---|---|---|---|
GRID_CRO_2D : 2-d cross-point grid data
|
B |
|
GRIDCRO2D |
||
GSPRO *: Speciation profiles
|
B |
|
gspro.cmaq.cb4p25.txt |
||
MET_FILE1 : Meteorology file containing temperature and radiation data
|
B |
|
|
||
* This file is used by more than one program. |
There are several directories that contain the raw SMOKE inputs. These are:
$ARDAT
: Raw area inputs
$BGDAT
: Raw biogenic inputs
$MBDAT
: Raw on-road mobile inputs
$NRDAT
: Raw nonroad mobile inputs (these can alternatively be included in the area directory)
$PTDAT
: Raw point inputs
: Other raw inputs not associated with a specific source category
$INVDIR
/other
: Shared data
$GE_DAT
: Raw MOBILE6 input files
$SMK_M6PATH
: Emission factor inputs (the single file that is considered a raw input file is actually prepared by the SMOKE scripts, when
these are being used).
$SMK_EMISPATH
: Meteorology data (this can be linked to a meteorology directory that is also used by the air quality model).
$METDAT
All of these directories are based on the
directory, which is set by the Assigns file as $SMKDAT
. The $SMK_HOME
/dataSMK_HOME
environment variable should be set as part of the SMOKE installation process, as described in Section 12.3, “Installing SMOKE”.
For the nctox case, these directories (based on your SMK_HOME
setting) are as follows:
: $SMKDAT
$SMK_HOME
/data
: $INVDIR
$SMKDAT
/inventory/nctox
: $ARDAT
$INVDIR
/area
: $BGDAT
$INVDIR
/biog
: $MBDAT
$INVDIR
/mobile
: $NRDAT
$INVDIR
/nonroad
: $PTDAT
$INVDIR
/point
: $GE_DAT
$SMKDAT
/ge_dat
: $SMK_M6PATH
$SMKDAT
/run_nctox/static/m6
: $SMK_EMISPATH
$SMKDAT
/run_nctox/static/m6emfac
: $METDAT
$SMKDAT
/met/run_12km