*** PLEASE READ THIS BEFORE RUNNING SMOKE. ***

== 1. Introduction ==

These packages contain scripts, inventories, and ancillary files 
related to the 2011_BaseA hemispheric emissions modeling case.

CMAQ model-ready emissions generated using these packages with 
SMOKE v4.0 should be nearly identical to those used in EPA's 2011v6.3 platform.
However, there may be emissions differences resulting from differences in the 
Linux operating system, hardware platform, and other system-specific 
differences.  

This hemispheric emissions modeling case uses components of EPA's 2011v6.3 platform 
in North America, and the HTAP_V2 gridded hemispheric emissions by EDGAR elsewhere in
the Northern Hemisphere, along with inputs from other data sources. 
Additional information on the 2011v6.3 platform is available here:
http://www.epa.gov/ttn/chief/emch/index.html#2011

The data files are divided into several directories: 
- 2011emissions contains emission inventories for the year 2011,
  including traditional CSV-based emissions inventories for North America,
  and EDGAR-based gridded emissions inventories for elsewhere in North America
- ancillary_inputs contains general ancillary files (ge_dat),
  including those related to speciation, spatial allocation (gridding),
  temporalization, and a gridded ocean chlorine emissions file
  which is included in the final model-ready emissions
- smoke_2011_hemispheric_platform.zip contains scripts to run SMOKE and utility programs
- spatial_surrogates contains 108km spatial surrogates for the polar stereographic 
  hemispheric modeling grid

Section 4 of this README includes information about the modeling 
sectors used in the platform.
Section 5 of this README includes information about the inventories
provided.
Section 6 of this README includes information about the ancillary
(non-inventory) files included.  
This package does not contain any inputs or documentation related to source
apportionment applications, or CAMx modeling.

== 2. Requirements for processing emissions for air quality modeling ==

If you are only reviewing inventories and not developing emissions
for air quality modeling, you do not need to install SMOKE or to follow
the instructions below.  Instead, unzip the files with the data of interest
and examine those and the corresponding reports that are provided.

If you plan to develop emissions for air quality modeling, SMOKE v4.0
is REQUIRED to process this case. SMOKE v4.0 is the first version of SMOKE
which supports hemispheric emissions modeling from EDGAR inventories.

Python:
We also recommend (if not require) python version 2.6 or later,
along with select python libraries. Many of the helper scripts included in this 
package use python. The python scripts within this package reference 
'#!/usr/bin/env python' or '#!/usr/bin/env python2.6'; you may need to change 
this on your computing platform.

== 3. Installation of data files and scripts ==

This readme covers the installation of the SMOKE inventories, scripts,
and ancillary files used for the 2011v6.3 platform for hemispheric modeling.

Choose an install directory on your system; we will refer to this directory
as "INSTALL_DIR". To review/reproduce emissions for all sectors, unzip 
all the .zip files into INSTALL_DIR. The packages have subdirectories 
embedded within them, so it is important that all files be unpacked in the 
same place in order for the scripts know where to find the inputs. 
If you are only interested in reproducing or examining emissions for specific 
sectors, you may download and unzip only the data for those sectors from the 
2011emissions directory, but for SMOKE processing you should also include the 
files in the directories: ancillary_inputs, smoke/smoke_core_scripts, and 
spatial_surrogates for the grid(s) you plan to run. Additionally, precompiled
SMOKE executables and I/O API utilities are available in 
smoke/smoke_precompiled_execs. The files in smoke/smoke_preproc_scripts and 
smoke/smoke_postproc_scripts are not necessary to run SMOKE; these are only 
for developing SMOKE inputs or processing SMOKE outputs.

All SMOKE inventories, scripts, and ancillary files used for the 2011v6.3 platform 
for hemispheric modeling are provided, except emission factor tables for onroad 
processing via SMOKE-MOVES. The full set of emission factor tables is too large to 
permanently store on the FTP server and instead are furnished upon request.

MCIP meteorology data is not included in the package. This is used for the afdust, 
onroad, and onroad_catx_adj sectors, and also all sectors with layered emissions
including US-based point sectors and some hemispheric sectors. See MET_ROOT 
instructions below.
  
Prior to running SMOKE, you will need to edit the INSTALL_DIR (your install directory) 
and MET_ROOT (location of MCIP meteorology data) environment variable definitions in
the "directory_definitions.csh" script located in each CASE/scripts directory.
This script is sourced by each of the individual run scripts for each sector.
Regarding the MCIP data, SMOKE only uses the GRIDCRO2D, METCRO2D, and METCRO3D files.

In the ptegu run script, you will also need to edit NAMEBREAK_HOURLY so that 
it equals the number of underscores in your INSTALL_DIR (the full path), 
plus 5 (for 2011_BaseA).
Example for 2011ek: if INSTALL_DIR = '/disk/your/home_directory/foo_foo/install_dir',
then set NAMEBREAK_HOURLY = 8 (3+5).

== 4. Case description and instructions for each sector ==

2011_BaseA emissions were processed for a 108km polar stereographic grid 
(HEMI_108k) and uses CB05 speciation, not CB6 speciation as was the primary
mechanism used in the 2011v6.3 platform. Emissions were processed for the CMAQ
air quality model.

Because stack parameters are not available for hemispheric emissions, the CMAQ model
was run not with the usual "inline" processing approach for layering point sources, but 
using 3-D emissions layered by SMOKE. Therefore, the scripts in this package calculate
plume rise for all sectors with emissions beyond layer 1. Some sectors calculate plume
rise based on stack parameters and meteorology (Laypoint), while others use pre-defined
layer fractions (Layalloc).

Emissions processing is split into "sectors". Each sector has its own run 
scripts for processing, with one (or more) run scripts per case.
(See section 7 for information about the run script zips.)

The sectors are listed in sections 4A through 4C.

== 4A. North America sectors ==

AFDUST: Particulate emissions from fugitive dust sources. This sector is 
processed in two steps. The first (Annual_afdust_HEMI_*) processes the annual 
inventory, and the second (Annual_afdust_adj_HEMI_*) applies adjustments - 
transportable fraction and meteorologically-based - and outputs the adjusted 
emissions under the sector name "afdust_adj". The afdust scripts must be 
run in that order.

AG: Agricultural ammonia emissions.

AGFIRE: Agricultural burning emissions.

CMV: Emissions from C1, C2, and C3 commercial marine sources, including ports 
and navigable waterways. While this sector in the 2011v6.3 platform includes
offshore C1/C2 marine emissions in the Atlantic and Pacific Oceans and the Gulf 
of Mexico, offshore emissions are NOT included here to prevent a double count with
the HTAP ships sector.

NONPT: Area source emissions not included in other sectors.

NONROAD: Off highway mobile source emissions.

NP_OILGAS: Area source oil and gas emissions.

ONROAD: On highway mobile source emissions for the Continental US, excluding 
California and Texas. This sector is processed using SMOKE-MOVES with multiple 
scripts as described in section 4B.

ONROAD_CATX_ADJ: On highway mobile source emissions, California and Texas only. 
This sector is processed using SMOKE-MOVES with multiple scripts as described 
in section 4B.

ONROAD_AKHIPRVI: On highway mobile source emissions for outlying areas of the US:
Alaska, Hawaii, Puerto Rico, and the Virgin Islands. These emissions are not
processed with SMOKE-MOVES, but are processed as an "area" sector using a monthly 
emissions inventory.

OTHAFDUST: Particulate emissions from fugitive dust sources in Canada. Just like with
afdust, this sector is processed in two steps. The first (Annual_othafdust_12US2_*) 
processes the annual inventory, and the second (Annual_othafdust_adj_HEMI*) applies 
adjustments - transportable fraction and meteorologically-based - and outputs the adjusted 
emissions under the sector name "othafdust_adj". The othafdust scripts must be 
run in that order. Fugitive dust emissions in Mexico are included in the othar
sector and do not need the same transportable fraction and meteorological adjustments 
that the Canada fugitive dust emissions in othafdust do.

OTHAR: Area source emissions from Canada and Mexico.

OTHON: Mobile source emissions from Canada and Mexico.

OTHPT: Point source emissions from Canada, Mexico, and offshore areas.
This is a 'point' sector, and like all 'point' sectors, is processed via
two scripts: the 'onetime' script, and the 'daily' script. The 'onetime' script
must be run first.
While this sector in the 2011v6.3 platform includes offshore C3 marine emissions 
in the Atlantic and Pacific Oceans and the Gulf of Mexico, offshore C3 emissions are 
NOT included here to prevent a double count with the HTAP ships sector. This sector
does still include emissions from Gulf of Mexico oil rigs, however.
This sector is processed with plume rise calculated by the Laypoint program.

PTEGU: Electric generating unit emissions. This sector incorporates CEM (Continuous 
Emissions Monitoring) hourly emissions for a majority of sources.
This is a 'point' sector, and like all 'point' sectors, is processed via
a 'onetime' script first, followed by a 'daily' script. For ptegu there are two 'daily'
scripts for different months of the year: 'summer' (May through September), and 'winter'
(October through April). For sources without hourly CEM emissions, summer and winter 
use different hourly temporalization, and so they are run with separate inputs.
You may need to change the NAMEBREAK_HOURLY setting in the run scripts, as 
described in the run script comments, and in section 3 of this readme.
This sector is processed with plume rise calculated by the Laypoint program.

PTNONIPM: Point source emissions from industrial activities.
This is a 'point' sector, and like all 'point' sectors, is processed via
two scripts: the 'onetime' script, and the 'daily' script. The 'onetime' script
must be run first.
This sector is processed with plume rise calculated by the Laypoint program.

PTFIRE3D: Point source emissions from year specific controlled burning and 
wild fires in the US. 
This is a 'point' sector, and like all 'point' sectors, is processed via
two scripts: the 'onetime' script, and the 'daily' script. The 'onetime' script
must be run first.
This sector is processed with plume rise calculated by the Laypoint program.

G_PTFIRE_MXCA: Point source emissions from year specific controlled burning and 
wild fires in Canada and Mexico. 
This is a 'point' sector, and like all 'point' sectors, is processed via
two scripts: the 'onetime' script, and the 'daily' script. The 'onetime' script
must be run first.
This sector is processed with plume rise calculated by the Laypoint program.

PT_OILGAS: Point source oil and gas emissions.
This is a 'point' sector, and like all 'point' sectors, is processed via
two scripts: the 'onetime' script, and the 'daily' script. The 'onetime' script
must be run first.
This sector is processed with plume rise calculated by the Laypoint program.

RAIL: Area source railway emissions.

RWC: Area source residential wood combustion emissions.

== 4B. Notes regarding onroad ==

Onroad emissions are processed using SMOKE-MOVES. The processing is split 
into multiple run scripts. In the 2011v6.3 platform, SMOKE-MOVES inputs were 
prepared using the latest version of MOVES: MOVES2014a.

As described in the SMOKE online documentation, SMOKE-MOVES handles onroad 
emissions separately for four types of processes:
- On-network emissions (RatePerDistance, or RPD)
- Off-network emissions, fuel vapor venting (RatePerProfile, or RPP)
- Off-network emissions, extended idling (RatePerHour, or RPH)
- Off-network emissions, non-venting, non-extended idle (RatePerVehicle, or RPV)

For each of the two onroad sectors (onroad, onroad_catx_adj), 
there are separate run scripts for RPD, RPP, RPH, and RPV, plus a merge script that 
combines emissions from RPD, RPP, RPH, and RPV into a single emissions file per day.

These scripts may take a particularly long time to run, especially RPD.
Therefore, consideration should be given to running multiple RPD jobs in
parallel, such as one job per quarter.

The reason onroad has been split into two sectors - onroad and onroad_catx_adj - 
is in order to match SMOKE-MOVES annual emission totals with those provided by 
California and Texas for non-refueling sources. To do this, we split California 
and Texas into a separate sector, and ran SMOKE-MOVES with a control factor 
file (CFPRO) which nudges the emissions so that the annual totals post-SMOKE-MOVES 
equal those provided by CARB and TCEQ. Both CARB and TCEQ provided updated onroad 
emissions inventories for use in the 2011v6.3 platform, and we match their provided 
emissions at the county/SCC6/process level for California/CARB, and the county/SCC 
level for Texas/TCEQ.

For the onroad sector, a CFPRO is provided in the ancillary_inputs/ge_dat_for_2011ek_other.zip 
package which zeroes out gasoline refueling emissions in 53 Colorado counties. We zero out
these emissions in order to prevent a double count with the ptnonipm sector, since that sector
includes gasoline refueling emissions in these counties.
Another CFPRO is provided for extended idle (RPH) emissions which cuts all extended idle
emissions in Maricopa County, Arizona, by 50%. This is in response to feedback received from
the 2011v6.2 platform.

== 4B1. DAYS_PER_RUN ==

SMOKE-MOVES can be run more efficiently if running more than one day at a time. For example,
Movesmrg can create one 7-day emissions file more quickly than it can create seven individual 
1-day emissions files. To turn on this feature, use the DAYS_PER_RUN variable, set to the number
of days you wish to run in a single Movesmrg instance. The recommended value for DAYS_PER_RUN
is 7. The onroad scripts include a setting called "DAYS_PER_RUN", set to 1 as the default. 

If DAYS_PER_RUN > 1, after Movesmrg is run, the run scripts will use the I/O API utility m3xtract
to split up the multi-day emissions file into single day (25-hour) emissions files.

Multi-day Movesmrg runs will never cross months. For example, if DAYS_PER_RUN = 7, then the last
Movesmrg run of January will start on January 29th and end on January 31st (3 days), and the first
Movesmrg run of February will start on February 1st and end on February 7th.

Using the multi-day Movesmrg functionality requires multi-day MCIP files. For example, if 
DAYS_PER_RUN = 7, your METCRO2D files must also be 7 days (169 hours) long.
These multi-day MCIP files should be stored in MET_ROOT/[grid]/mcip_out/Xday/, 
where X = DAYS_PER_RUN (i.e. /7day for DAYS_PER_RUN = 7).

The primary drawback to using this multi-day Movesmrg functionality is an increase in the 
memory usage.

== 4C. Hemispheric sectors ==

Hemispheric modeling sectors use gridded inventories from HTAP_V2, unless otherwise noted:
http://edgar.jrc.ec.europa.eu/htap_v2/

These gridded inventories include emissions for the entire globe, including North America.
To prevent a double count with North America modeling sectors (see Section 4A), emissions
from these sectors which are in North America are zeroed out using the Cntlmat program within
SMOKE, except for: the aircraft sectors (G_AIR_*) which do not double-count any of the 
2011v6.3 platform-based emissions sectors; and the biogenic emissions, which are used throughout
the domain instead of running BEIS as in the 2011v6.3 platform.

G_AG: Global agriculture emissions from HTAP.

G_AGFIRE: Global agricultural waste burning emissions. These emissions are not from HTAP.
This sector is processed with plume rise calculated by the Layalloc program using
constant layer fractions.

G_AIR_CDS: Global aircraft emissions from HTAP, climbing and descent.
This sector is processed with plume rise calculated by the Layalloc program using
constant layer fractions.

G_AIR_CRS: Global aircraft emissions from HTAP, cruising.
This sector is processed with plume rise calculated by the Layalloc program using
constant layer fractions.

G_AIR_LTO: Global aircraft emissions from HTAP, landing and takeoff.
This sector is processed with plume rise calculated by the Layalloc program using
constant layer fractions.

G_BIOG: Global biogenic emissions. These emissions are not processed through SMOKE, and
instead are already provided in a model-ready format for the hemispheric modeling grid 
These pre-processed model-ready emissions are available in this zip:
2011emissions/2011_BaseA_global_biogenics_gridded.zip

G_ENERGY: Global energy sector emissions from HTAP.
This sector is processed with plume rise calculated by the Layalloc program using
constant layer fractions.

G_INDUSTRY: Global industrial emissions from HTAP.
This sector is processed with plume rise calculated by the Layalloc program using
constant layer fractions.

G_PTFIRE: Global fire emissions from the NCAR FINN inventory for use outside North America.
This sector is processed with plume rise calculated by the Layalloc program using
constant layer fractions. Computational restrictions prevented us from having SMOKE calculate
plume rise with Laypoint for these fires.

G_RESIDENTIAL: Global residential sector emissions from HTAP.

G_SHIPS: Global offshore shipping emissions from HTAP.

G_TRANSPORT: Global transportation sector emissions from HTAP.

== 4D. Sector merge ==

After all sectors have been processed, the Sector_merge script merges
the low-level emissions from all sectors into a single CMAQ-ready emissions file
per day.

Merged model-ready emissions will be output to:
INSTALL_DIR/$CASE/smoke_out/$CASE/HEMI_108k/$SPC/

Inline emissions files would be output to the same directory, except in 
subdirectories by sector name (e.g. .../$SPC/ptnonipm/). Inline emissions are not
created in this emissions case, however.

== 4E. Spinup emissions ==

CMAQ hemispheric modeling uses a four-month spinup period, instead of the typical 10 day
spinup period. Because of the length of the spinup period, more attention is given to
processing the spinup emissions than in a usual emissions case.

For the four-month spinup period, which covers September 2010 through December 2010, 
inventories and scripts for processing 2010-specific fire emissions are provided.

2010 fire inventories are in this zip file: 2011emissions/2011_BaseA_spinup_global_inputs_fires.zip
US fires (ptfire sector) are included for all of 2010. For Canada/Mexico fires (g_ptfire_mxca 
sector) and non-North America fires (g_ptfire sector), only fires for August through December are 
included. August is included to cover the first few hours of 9/1/2010 GMT, which in local time
in the western hemisphere is part of August.

Scripts for processing the 2010 fire inventories for September through December are
included in smoke_2011v6_3_hemispheric_platform.zip, and are extracted to the 
$INSTALL_DIR/2011_BaseA_spinup/scripts/ directory. These emissions will be processed under
a different case name, 2011_BaseA_spinup, than the 2011 base year emissions.

In that same .zip, a script for merging the spinup emissions is extracted to the same area.
The model-ready emissions for September through December 2010 will include fire emissions 
from 2010, and other emissions from 2011, and will also be output under the 2011_BaseA_spinup
case name.

== 5A. Description of inventory packages from 2011v6.3 platform ==

Inventories for the US, Canada, and Mexico from the 2011v6.3 emissions platform are included 
in the following files, all of which should be unpackaged in INSTALL_DIR:

Located in ftp.epa.gov/EmisInventory/2011v6/hemispheric directory:
- 2011emissions/2011ek_cb6v2_v6_11g_inputs_onroad_plus_akhiprvi.zip

Located in ftp.epa.gov/EmisInventory/2011v6/v3platform/2011emissions/:
- 2011emissions/2011ek_cb6v2_v6_11g_inputs_cem.zip
- 2011emissions/2011ek_cb6v2_v6_11g_inputs_nonpoint.zip
- 2011emissions/2011ek_cb6v2_v6_11g_inputs_nonroad_part1.zip
- 2011emissions/2011ek_cb6v2_v6_11g_inputs_nonroad_part2.zip
- 2011emissions/2011ek_cb6v2_v6_11g_inputs_oth.zip
- 2011emissions/2011ek_cb6v2_v6_11g_inputs_point.zip
- 2011emissions/2011ek_cb6v2_v6_11g_inputs_ptfire.zip

The "cem" package includes the hourly CEM (Continuous Emissions Monitoring)
emissions used by the ptegu sector. This is the same data as is available on 
EPA's Air Markets Program Data website (ampd.epa.gov), except that we've split 
the data into months and days as needed for our scripts.

The "inputs_nonpoint" package includes inventories for the following sectors:
afdust, ag, agfire, cmv, nonpt, np_oilgas, rail, rwc.

The two "inputs_nonroad" packages include the inventories for the nonroad sector.
It was split into two .zips in order to reduce the size of each individual .zip.
The "part1" zip includes all states from Alabama to Missouri, alphabetically, except
for California (FIPS 01 through 29, except 06).
The "part2" zip includes all states from Montana to Wyoming, alphabetically, and
also California (FIPS 30 through 56, plus 06). Part 2 also includes Puerto Rico
and U.S. Virgin Islands.

The "inputs_onroad_plus_akhiprvi" package includes most inputs for running 
SMOKE-MOVES for the Continental US, such as the activity data for the onroad and
onroad_catx_adj sectors. It does not include the emission factor tables also
required to run SMOKE-MOVES; these are not stored on the FTP site due to their large
size and instead are furnished upon request. CB05 and CB6 each have a separate
set of emission factor tables.
This package also includes onroad emissions inventories for Alaska, Hawaii, 
Puerto Rico, and the U.S. Virgin Islands, which are commonly referred to collectively 
as "AK/HI/PR/VI". Onroad emissions for AK/HI/PR/VI are not processed with SMOKE-MOVES
due to a lack of MOVES-based emission factors in those areas, but instead are processed
using "traditional" SMOKE processing methods with a FF10-formatted monthly inventory.

The "inputs_oth" package includes the inventories for Canada, Mexico, and
offshore emissions. These are used by the othafdust, othar, othon, and othpt sectors.
In the hemispheric modeling case, however, offshore marine vessel emissions are not 
included in the othpt sector and are instead included in the G_SHIPS sector.

The "inputs_point" package includes the inventories for the following sectors:
ptnonipm, ptegu, pt_oilgas.

The "inputs_ptfire" package includes the inventories for the ptfire3D sector.

The "inputs" packages also include sample list (.lst) files, which list
the inventories used by each sector. The run scripts automatically create new 
.lst files with the correct paths, so there is no need to edit these unless you 
are running SMOKE with your own scripts.

See section 4 for a description of each modeling sector.

== 5B. Description of hemispheric inventory packages ==

Inventories for the remainder of the globe, covering emissions not included in the
2011v6.3 platform-based packages listed above, are included in the following files, 
all of which should be unpackaged in INSTALL_DIR:

2011emissions/2011_BaseA_global_biogenics_gridded.zip
2011emissions/2011_BaseA_global_inputs_fires.zip
2011emissions/2011_BaseA_global_inputs_HTAP_industry.zip
2011emissions/2011_BaseA_global_inputs_HTAP_other.zip
2011emissions/2011_BaseA_global_inputs_HTAP_residential.zip
2011emissions/2011_BaseA_spinup_global_inputs_fires.zip

The "global_biogenics_gridded" package includes model-ready biogenic emissions
covering the entire hemispheric domain, including in North America. These biogenic
emissions are used in North America in lieu of biogenic emissions produced in SMOKE with
the BEIS model. These emissions do not need to be processed through SMOKE. Instead,
they only need to be included in the final sector merge.

The "global_inputs_fires" package includes fire inventories covering all areas outside
the US, including in Canada and Mexico. Canada and Mexico are included here because
the source of the g_ptfire_mxca fire inventories is the same as the source of the g_ptfire 
(outside North America) fire inventores: the Fire Inventory from NCAR (FINN).

The "global_inputs_HTAP_industry" package includes global monthly gridded emissions 
inventories for the industry sector (g_industry) from HTAP version 2.

The "global_inputs_HTAP_residential" package includes global monthly gridded emissions 
inventories for the residential sector (g_residential) from HTAP version 2.

The "global_inputs_HTAP_other" package includes all other global gridded emissions
inventories, some monthly and some annual, and mostly from HTAP version 2. This
includes inventories for the following sectors: g_ag, g_agfire, g_air_cds, g_air_crs,
g_air_lto, g_energy, g_ships, g_transport.

TThe "spinup_global_inputs_fires" package includes fire inventories for the entire globe,
including in the US, Canada, and Mexico, for September through December 2010.
See section 4E for more information about the spinup period.

he "inputs" packages also include sample list (.lst) files, which list
the inventories used by each sector. For sectors with gridded emissions inventories,
these .lst files include full paths, referenced by $INSTALL_DIR, to the gridded inventories.
The run scripts automatically create new .lst files where $INSTALL_DIR has been replaced with
the full path, so there is no need to edit these unless you are running SMOKE with your own 
scripts.

See section 4 for a description of each modeling sector.

== 6. Description of ancillary file packages ==

The following packages should be unpacked in INSTALL_DIR:

ancillary_data/ge_dat_for_2011_hemi_gridding.zip
ancillary_data/ge_dat_for_2011_hemi_other.zip
ancillary_data/ge_dat_for_2011_hemi_speciation.zip
ancillary_data/ge_dat_for_2011_hemi_temporal.zip
ancillary_data/ocean_chlorine_hemispheric.zip
spatial_surrogates/surrogates_HEMI_108k.zip

The "surrogates" package contains the gridding surrogates for the 108km-resolution
hemispheric modeling domain.

The "gridding" package includes all SMOKE inputs related to gridding other
than the spatial surrogates, including:
- cross-references (AGREF, MGREF)
- surrogate descriptions (SRGDESC) 
- gridded transportable fractions used in afdust_adj and othafdust_adj (XPORTFRAC)
- the GRIDMASK file, used by SMOKE to assign emissions from gridded emissions 
  inventories to individual countries or bodies of water
- layer fractions for many HTAP-based sectors

The "speciation" package includes speciation profiles, cross-references,
and VOC-to-TOG conversion factors. This .zip supports the CB05 mechanism only. 

The "temporal" package includes temporal profiles and cross-references, including
daily and hourly temporal profiles developed by the SMOKE program Gentpro for use in the
rwc and ag sectors, respectively.

The "other" ge_dat package includes all other SMOKE ancillary files not included in
the above packages, including:

- Inventory tables (INVTABLE)

- Lists of sources to exclude from CAP/HAP integration (NHAPEXCLUDE)

- SMOKE-MOVES ancillary files, including the reference county (MCXREF) and fuel month (MFMREF)
  cross-references, pollutant (MEPROC) and emission factor table (MRCLIST) lists, 
  activity SCC to full SCC cross-references (SCCXREF), hourly speed profiles (SPDPRO), 
  daily temperature data (METMOVES), and control factors for onroad_ca_adj and Colorado gasoline
  refueling (CFPRO)
  
- The new GEOCODE1, GEOCODE2, GEOCODE3, and GEOCODE4 files, which include SMOKE 4.0-formatted
  country codes and are used along with the GRIDMASK file to allocate gridded emissions 
  to individual countries and bodies of water
  
- GCNTL files, used by Cntlmat to zero out North America emissions from most HTAP-based 
  hemispheric emissions sectors

- Other miscellaneous SMOKE inputs, such as the ARTOPNT, COSTCY, HOLIDAYS, MACTDESC, 
  NAICSDESC, ORISDESC, PELVCONFIG, PSTK, SCCDESC
  
- Smkreport configuration files (REPCONFIG, all in ge_dat/smkreport/repconfig)

This ocean_chlorine.zip package contains gridded ocean chlorine emissions,
which are included in the sector merge. Unzip in INSTALL_DIR.

The run scripts (see section 7) are already set up to use the proper ancillary
files and inventories for each sector and case.

== 7. Description of script packages ==

The smoke_2011v6_3_hemispheric_platform.zip package should be unpacked in INSTALL_DIR.
This includes scripts and precompiled executables for running SMOKE in general,
and for running the 2011_BaseA emissions modeling case in particular.

The scripts in the 2011_BaseA and 2011_BaseA_spinup subdirectories are the scripts you 
run directly in order to replicate our emissions. Separate script(s) are provided for each 
sector.

See section 4 for information pertinent to each sector. In general, you edit
the directory_definitions.csh file, in particular INSTALL_DIR and MET_ROOT,
and then run each sector.
Sector scripts are organized into subdirectories within CASE/scripts by
sector category: HTAP, nonpoint, onroad, point, and merge.

For afdust sectors, run afdust/othafdust first, then afdust_adj/othafdust_adj.
For point sectors, run "onetime" first, and then "daily".
For onroad sectors, run RPV/RPD/RPH/RPP first, then the merge.

The scripts, programs, and other inputs in the following subdirectories are all 
"helper" scripts and inputs, and generally never need to be run directly:
ioapi, scripts, smoke4.0