The control file is a critical input for any model run. It should be a text file (with extension .txt) created in any text editor (e.g., TextEdit, Notepad++, Worded).
There is a template control file stored in the templates folder of the ECHO-AIR Model repository. This version will always be the most up-to-date. It is good practice to check the templates folder before starting a new run.
The tables below describe all of the fields of the control file. The “Required” column indicates if the input is required for the tool to run. If it is not required, ECHO-AIR will assume a default value. Additionally, the table below includes a suggestion for inputs for the test data.
Meta Data
This section provides the model with a naming structure for output files.
Field
Required
Description
Test Data Input
BATCH_NAME
No
Provides a name for the batch of runs
test
RUN_NAME
No
Provides a run-specific name
cy2000
Emissions Data
Field
Required
Description
Test Data Input
EMISSIONS_FILENAME
Yes
Provides the path to the emissions file. For shapefiles, use the .shp file.
Indicates whether you want health results. If blank, will run only concentrations.
Y
RACE_STRATIFIED_INCIDENCE
No
Future option, currently does not do anything.
N
Run Controls
Field
Required
Description
Test Data Input
CHECK_INPUTS
No
If enabled, will check all of your inputs and then exit.
N
VERBOSE
No
If enabled, it will output more logging statements.
Y
Output Options
Field
Required
Description
Test Data Input
REGION_OF_INTEREST
No
If provided an input, will output results only for this region.
leave blank
REGION_CATEGORY
No
If provided an region of input, provide the type of region (e.g., AD = Air District, AB = Air Basin, C = County).
leave blank
OUTPUT_RESOLUTION
No
If provided, will aggregate results from ISRM grid cell to provided resolution.
leave blank
OUTPUT_EXPOSURE
No
If enabled, will output population with concentration data.
leave blank
DETAILED_CONC
No
If enabled, will output concentration data with additional columns for the precursor species
leave blank
OUTPUT_EMIS
No
If enabled, will output emissions allocated to the ISRM grid
leave blank
Options for Output Regions
The following keywords are pre-programmed for use in ECHO-AIR for evaluating specific regions in California. All of the key words should be input in all capitals. Jump ahead to Air Basins, Air Districts, and Counties.