GAMAP v2–19 User Guide

Previous | Next | Printable View (no frames)

5. GAMAP Reference

Here you may view the manual pages for all of the individual GAMAP routines, sorted by category and by alphabetical order. (Note: A separate browser window will be opened.)

NOTE: You may use the GAMAP routine ADD_TEMPLATE to add a standard documentation header (which you can then further edit) to the top of any IDL source code routine. Then you can use the GAMAP routine IDL2HTML to convert the text of the standard documentation header to HTML format. This makes it very easy to automatically create manual pages for IDL routines.

5.1 All GAMAP routines

Click HERE to display a list of all source code routines included with the GAMAP distribution.

5.2 GAMAP routines sorted by alphabetical order

Click on the links below to view the manual pages for GAMAP routines, sorted by alphabetical order.

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

5.3 GAMAP routines sorted by category

The individual IDL source code routines which comprise the GAMAP v2–16 package have been sorted into the following categories. Note that some GAMAP routines may be cross-listed among more than one category, or further classified into sub-categories.

GAMAP Category
or Subcategory
Description
Atmospheric Sciences Routines that perform atmospheric chemistry computations.
Benchmarking Routines that create standard comparison plots for GEOS-Chem 1-month benchmark simulations.
Color Routines that define the color table and color bar.
Date & Time Routines that compute and/or format the date and time.
Documentation Routines for documenting IDL source code.

File & I/O

Routines that read data from / write data to disk. There are 2 sub-categories:

GAMAP Examples Routines that educate users about the various features of GAMAP.

GAMAP Internals

Internal GAMAP routines (i.e. not meant to be called by GAMAP users directly). There are 3 subcategories:

GAMAP Utilities

GAMAP routines for displaying, reading, and plotting data. (These routines comprise most of the routines that used to be in the old ~/IDL/gamap directory from previous versions of GAMAP.) There are 3 subcategories.

General Miscellaneous IDL routines that do not fall into any of the other categories.
Graphics Routines for reading from / writing to various graphic data file formats such as GIF, JPEG, BMP, PNG, TIFF, etc.
Math & Units Routines for math, statistics, and unit conversion.
Plotting General plotting routines (not specific to CTM's such as in the "GAMAP Plotting" category).
Regridding Routines for regridding data from one model grid to another.
Strings Routines for working with strings.
Structures Routines for working with structures.
Time Series Routines for working with 4-D Time Series data.
(Click HERE for a brief tutorial about working with this type of data.)

5.4 View the REVISIONS logs for GAMAP source code routines

Click on the links below to view the revision history for GAMAP routines in each of the following source code directories:

Previous | Next | Printable View (no frames)