ipygrads (version 1.0.6)
index
/Users/dasilva/src/pygrads/ipygrads.py

This module defines "magic commands" for using GrADS interactively
from within iPython. This module is usually imported from the
configuration file "ipythonrc-grads". At any time, on-line help is
available with these commands:
 
    help(ipygrads)   This document
    qref             PyGrADS quick reference
    examples         Some PyGrADS examples
 
Based on command line arguments supplied by the user, the top level
script "pygrads" defines key environments variables necessary for this
module to start a GrADS connection, defining the global object "ga".
You can use "ga" to interact with GrADS directly:
 
    ga("q config")
 
However, a number of shortcuts are provided so that rarely one needs
to explicitly type "ga.cmd(...)". The following generic GrADS commands
are available:
 
    clear/c, define, disable, display/d, draw, enable, 
    Open/o, Print/pp, printim/pim, Set/s, query/q, reinit 
 
Notice that some commands (e.g., "Open") are capitalized to avoid
conflict with standard Python keywords.
 
In addition, any generic GrADS command can be entered by starting the
line with a period and a space ('. '), for example example
 
    . open model.ctl
    . display ps
 
The following convenience aliases are provided:
 
    cb         run cbarn (for color bar script)
    sh         set gxout shaded
    yat        run gxyat
 
These shortcuts run specific methods from module "grads" on the GrADS
object "ga":
 
    dd $name   runs the "imp" method, displaying a NumPy array in 
               GrADS; this is equivalent to 
                    ga.imp('<display>',$name)
    eof $name  compute EOS using Singular Value Decomposition; the
               *time* dimension contains the eofs; this equivalent to:
                $name,$name_d,$name_c = ga.eof('$name')
    ii $name   runs the "imp" method, importing a NumPy array into
               GrADS; this is equivalent to 
                     ga.imp("$name",$name)
    oo $fname  runs the "open" method,  setting "fh"
    qq $what   runs the "query" method, setting "qh"
    xx $name   runs the "exp" method, returning a NumPy array and an
               associated grid with coordinate information.
               This magic command is equivalent to 
                    $name = ga.exp("$name")
                    $lon  = $name.grid.lon
                    $lat  = $name.grid.lat
                    $lev  = $name.grid.lev
                    $time = $name.grid.time
 
The shortcuts "dd/ii/xx" are somewhat limited interfaces to the
"imp"/"exp" methods as they do not work on expressions; use
"ga.imp()"/"ga.exp()" directly for a more flexible alternative.
 
For additional information on these and other methods, consult the
documnentation for the main classes:
 
   help('grads')
   help('GrADS')
   help('GaNum')
   help('GaLab')
   help('gacm')

 
Modules
       
IPython
PIL.Image
matplotlib.toolkits.basemap.cm
matplotlib.cm
grads.gacm
grads.gacore
grads.galab
grads.ganum
numpy.core.ma
grads.numtypes
os
sys

 
Functions
       
ceil(...)
ceil(x)
 
Return the ceiling of x as a float.
This is the smallest integral value >= x.
floor(...)
floor(x)
 
Return the floor of x as a float.
This is the largest integral value <= x.
fromfile(...)
fromfile(file=, dtype=float, count=-1, sep='') -> array.
 
Required arguments:
    file -- open file object or string containing file name.
 
Keyword arguments:
    dtype -- type and order of the returned array (default float)
    count -- number of items to input (default all)
    sep -- separater between items if file is a text file (default "")
 
Return an array of the given data type from a text or binary file. The
'file' argument can be an open file or a string with the name of a file to
read from.  If 'count' == -1 the entire file is read, otherwise count is the
number of items of the given type to read in.  If 'sep' is "" it means to
read binary data from the file using the specified dtype, otherwise it gives
the separator between elements in a text file. The 'dtype' value is also
used to determine the size and order of the items in binary files.
 
 
Data written using the tofile() method can be conveniently recovered using
this function.
 
WARNING: This function should be used sparingly as the binary files are not
platform independent. In particular, they contain no endianess or datatype
information. Nevertheless it can be useful for reading in simply formatted
or binary data quickly.
gaOpen(self, arg)
gaQuery(self, arg)
gacbarn(self, arg)
gaclear(self, arg)
gacmd(self, arg)
gad(self, arg)
gadefine(self, arg)
gadisable(self, arg)
gadisplay(self, arg)
gaenable(self, arg)
gaeof(self, arg)
gaexample(self, arg)
gai(self, arg)
gaopen(self, arg)
gapgx(self, arg=' ')
gapim(self, arg)
gaqref(self, arg)
gaquery(self, arg)
gareinit(self, arg)
gaset(self, arg)
gashaded(self, arg)
gax(self, arg)
gayat(self, arg)
grads_(self, arg=' ')
gradsc(self, arg)
gradshdf(self, arg)
gradsnc(self, arg)
inner(...)
innerproduct(a,b)
Returns the inner product of a and b for arrays of floating point types.
Like the generic NumPy equivalent the product sum is over
the last dimension of a and b.
NB: The first argument is not conjugated.
maketrans(...)
maketrans(frm, to) -> string
 
Return a translation table (a string of 256 bytes long)
suitable for use in string.translate.  The strings frm and to
must be of the same length.
time(...)
time() -> floating point number
 
Return the current time in seconds since the Epoch.
Fractions of a second may be present if the system clock provides them.
zeros(...)
zeros((d1,...,dn),dtype=float,order='C')
 
Return a new array of shape (d1,...,dn) and type typecode with all
it's entries initialized to zero.

 
Data
        HAS_GACM = True
HAS_GALAB = True
HAS_PIL = True
StringTypes = (<type 'str'>, <type 'unicode'>)
__version__ = '1.0.6'
ascii_letters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
ascii_lowercase = 'abcdefghijklmnopqrstuvwxyz'
ascii_uppercase = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
cos = <ufunc 'cos'>
digits = '0123456789'
hexdigits = '0123456789abcdefABCDEF'
ip = None
letters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
lowercase = 'abcdefghijklmnopqrstuvwxyz'
newaxis = None
octdigits = '01234567'
pi = 3.1415926535897931
printable = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~ \t\n\r\x0b\x0c'
punctuation = '!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~'
sqrt = <ufunc 'sqrt'>
uppercase = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
whitespace = '\t\n\x0b\x0c\r '