===========
WHIPS 1.0.5
===========

Wisconsin Horizontal Interpolation Program for Satellites (WHIPS)
=================================================================

* **Project Title:** WHIPS
* **Purpose of Project:** Provide a well-documented, easy-to-use general-purpose processing module for processing satellite data
* **Version:** 1.0.5 (3/26/2012)
* **Authors:** oberman, maki, strom
* **Contact:** oberman@wisc.edu


QUICK START
-----------


1. Install the program and run the built-in test module to confirm
that it is working properly.  Installation instructions can be found
in the file INSTALL.txt


2. Download whatever data you plan to process.  Currently, the program
is designed to process OMI NO2 DOMINO level 2 data, OMI NO2 NASA level
2 data and MOPITT CO data.  See the detailed documentation for the
--filelist argument for locations of data.


3. Navigate to the folder where whips.py is located (or add it to
your path) and invoke it as:

     whips.py --help


4. Follow the on-screen instructions, adding each of the required
parameters.  If you need help with the projection attributes or the
output function attributes, invoke the built-in help as:

     whips.py --AttributeHelp <function_name>

For detailed explanations of all parameters and attributes, see the
"Parameter Details" section below.


5. Invoke whips.py once for each output file you'd like to create.
Note that the software creates output files with only a single
timestep, so you'll need to invoke the command once for each timestep
(IE if you want a month with timesteps every day, you'll probably want
to write a shell script that calls the command once for each day)


6. Additionally, you may create a grid file for your chosen grid by
including the --includeGrid flag followed by the desired filename.
A file containing the gridcells used by the projection will be written
to the same directory as the standard output file.


7. Concatenate your outputs if desired (the authors recommend the NCO
operators at http://nco.sourceforge.net/ if you're using a netCDF
output format) and carry on!

