Documentation

Manual Pages

The core of the OpenGrADS documentaion is accessible through the a href=/web/20110727151140/http://opengrads.org/wiki/index.php?title=Main_Page#Documentation OpenGrADS Wiki. Here you find Manual Pages, or reference documentation generated automatically from the source code.

Only the most recent version of these manual pages will be posted on-line. A version matching the software you are using will come it. For example, if your OpenGrADS has been properly configured, Perl and User Defined Extensions are accessible with peldoc:

% perldoc re

Python documentation can accessed with pydoc:

% pydoc grads

Contents

• OpenGrADS Bundle Front-ends
• Scripts
• User Defined Extensions
• Gerl: Perl Interface to GrADS
• PyGrADS: Python Interface to GrADS
• Windows
• GrADS with Athena Widgets

OpenGrADS Bundle Front-ends

• Wiki page
• grads - the basic grads front end
• opengrads - grads front end with colorized text and persistent readline history
• merra - grads front end starting an Athena GUI for visualizing MERRA files; see this recipe for a description of the MERRA Visualization Tool .

Scripts

• LATS4D - Subsetting, reformatting and regriding; see also the wiki page.

User Defined Extensions

• Wiki page
• Env - Environment Variable Manipulation
• Fish - Streamfunction and Velocity Potential
• GsUDF - Writing User Defined Functions as GrADS Scripts
• Grib2 - Reading Grib-2 Files in GrADS v1.9
• GxYAT - A command for creating hight quality images in PNG, Postscript, PDF and SVG formats
• Libbjt - Ben-Jei Tsuang's Function Collection
• LibLATS - File Conversion and Subsetting
• Libmf - Mike Fiorino's Extension Collection
• Libipc - Functions for Inter-process Communication
• Orb - Satellite Orbit Masking
• Re - 2D Regridding
• Saakeskus - Total Totals, Storm-relative Helicity, Potential instability, Wind-chill temperature and other thunderstorm related indices.
• Shape - Plotting of Shapefiles (basemaps, etc.)
• ShFilt - Spherical Harmonic Filtering

Gerl: Perl Interface

• Wiki page
• GrADS Client Class
• Procedural interface to Grads Client Class
• Wrapper for PDL command line interpreter

PyGrADS: Python Interface

• Wiki page
• The GrADS Package
• IPython Aliases (Magic Commands)

GrADS for Microsoft(tm) Windows

• Wiki page
• Getting Started with Win32 GrADS Version 1.9
• Getting Started with Win32 GrADS Version 2.0

Using GrADS with Athena Widgets

• Introduction
• Running the sample script
• Writing simple scripts
• Writing the sample script
• Going further...
• Reference Section