opengrads-devel

[Opengrads-devel] UDXT documentation

[Arlindo da S. <da...@al...>]

All,
  I spent sometime this weekend updating the documentation of the UDXTs. The
revised man pages are here

       http://opengrads.org/doc/

  These have been derived from source code using pod2html, and uses a new
pod.css I introduced to match the OpenGrADS general layout. For the first
time I have documentation for the environment variable extension (env) and
gsudf, a device for writing GrADS UDFs as script functions (these used to be
entirely separate, now the line is blurred).

   B.-J.: I have add a very rough skeleton for the libbjt documentation,
based on what I could derive from your example script. There is still a lot
of gaps that I need your help with. The documentation is stored within the
sources. To get to it, checkout

% gacvs co -P Grads   (notice capital "G")
% cd extensions/libbjt

and edit file libbjt.c. To see the formatted documentation on the screen
type

% perldoc libbjt.c

which should give you a man page kind of output. Type

% make html

to create libbjt.html, the same as this page:

    http://opengrads.org/doc/udxt/libbjt/


(You may need to install packages named something like perl-doc or
perl-pod.) If you don't know POD do not worry about getting the perfect
format, I can fix that later. Just type in the arguments and general
description for the function in the "FUNCTIONS PROVIDED" section. I already
entered the examples I got from you for some of the functions. You have a
great collection of very useful functions; with a bit of documentation
others may be able to take advantage of all your hard work. Thanks.


 My plan is to work with Mike to make some adjustments to fish, some touch
ups in shape, complete the documentation and then release a new version of
the UDXTs, including the grib2 capability for v1.9.


 Any comment greatly appreciated.


 Cheers!


  Arlindo.







-- 
Arlindo da Silva
da...@al...

Re: [Opengrads-devel] UDXT documentation

[Ben-Jei T. <bt...@ya...>]

Dear Arlindo:

 

Thank you for your all effort, especially to make some documents for my
code. Could you send me the file "libbjt.c"? I forgot how to use cvs to
check out the file. 

 

In fact, all my function provides a help itself. Simply type 

 

 

d function_name

 

The user should be able to find the help. For example

 

d lw

 

ga-> d lw

Error from LW:  12-15 arguments expected 

lw(pl,ta,wa,taucl,fcld,ps,tg,eg,tb,wb,tauclb,fcldb
[,'binfile','ctlfile',-r-c-h-l]) 

usage:

Function returns: thermal infrared fluxes

Following the NASA Technical Memorandum (NASA/TM-2001-104606,

Vol. 19) of Chou, Suarez, Liang, and Yan (2001). This NASA TM

has been revised a few timessince. It computes thermal infrared

fluxes due to emission by water vapor, ozone, co2, o2, minor

trace gases, clouds, and aerosols and due to scattering by

clouds and aerosols.

 

Arguments:

   pl = level pressure (hPa)

   ta = layer temperature (K)

   wa = layer specific humidity (kg/kg)

   taucl= cloud optical thickness (dimensionless)

   fcld= cloud amount (fraction)

         (low cloud >700 hPa >= middle cloud > 400 hPa >= high cloud 

   ps = surface pressure (hPa)

   tg = land or ocean surface temperature (K)

   eg = land or ocean surface emissivity (fraction)

   tb = surface air temperature (K)

   wb = surface air specific humidity (kg/kg)

   tauclb= surface cloud optical thickness (dimensionless)

   fcldb= surface cloud amount (fraction)

   binfile = binary file name ('null' or blank for no output)

   ctlfile = ctl file name ('null' or blank for no output)

   -r = using Roberts et al. (1976) water vaopr continuum

   -c = using Clough et al. (1989) water vaopr continuum (default)

   -h = using look-up table (high acc but slow) (default)

   -l = using k-dist method (low acc but fast)

Operation Error:  Error from lw function

  Error ocurred at column 1

DISPLAY error:  Invalid expression 

  Expression = lw

 

ga-> d line

 

line(exp,x0,y0,x1,y1[,-l|-m|-r]) 

usage:

Function returns: draw line from (x0,y0) to (x1,y1)

  Set the line at the value val (default 1)

  using the template of exp

Arguments:

   (x0,y0),(x1,y1): coordindates in (lon, lat)

   -l: return the length [km] in each grid

   -m: return the logics (1:pass, 0: non-passing)

   -r: return the length ratio of each segment (fraction)

 

-----------------------------------------------

 

Perhaps, we can just provide this kind of documentation meanwhile. 

 

 

 

Ben

 

 

-----------------------------------------

  _____  

From: ope...@li...
[mailto:ope...@li...] On Behalf Of Arlindo
da Silva
Sent: Monday, March 24, 2008 12:07 PM
To: ope...@li...
Subject: [Opengrads-devel] UDXT documentation

 

All,

 

  I spent sometime this weekend updating the documentation of the UDXTs. The
revised man pages are here

 

       http://opengrads.org/doc/

 

  These have been derived from source code using pod2html, and uses a new
pod.css I introduced to match the OpenGrADS general layout. For the first
time I have documentation for the environment variable extension (env) and
gsudf, a device for writing GrADS UDFs as script functions (these used to be
entirely separate, now the line is blurred). 

 

   B.-J.: I have add a very rough skeleton for the libbjt documentation,
based on what I could derive from your example script. There is still a lot
of gaps that I need your help with. The documentation is stored within the
sources. To get to it, checkout 

 

% gacvs co -P Grads   (notice capital "G")

% cd extensions/libbjt

 

and edit file libbjt.c. To see the formatted documentation on the screen
type

 

% perldoc libbjt.c

 

which should give you a man page kind of output. Type

 

% make html

 

to create libbjt.html, the same as this page:

 

    http://opengrads.org/doc/udxt/libbjt/

 

(You may need to install packages named something like perl-doc or
perl-pod.) If you don't know POD do not worry about getting the perfect
format, I can fix that later. Just type in the arguments and general
description for the function in the "FUNCTIONS PROVIDED" section. I already
entered the examples I got from you for some of the functions. You have a
great collection of very useful functions; with a bit of documentation
others may be able to take advantage of all your hard work. Thanks.

 

 My plan is to work with Mike to make some adjustments to fish, some touch
ups in shape, complete the documentation and then release a new version of
the UDXTs, including the grib2 capability for v1.9.

 

 Any comment greatly appreciated.

 

 Cheers!

 

  Arlindo.

 

 

 

 

 

 


-- 
Arlindo da Silva
da...@al...