Documenting GEOS-5 Gridded Components

Steps to update GEOS-5 documentation. As an example, we consider the GridComp FVdycore_GridComp.

Update ProTeX

$ cd $ESMADIR/src/Config
$ cvs up -r b_pchakrab_G20Udoc protex

For a guideline to generate documentation using ProTeX, please see ProTeX guidelines.

Modified version of source file

The modified version of the source file (that works with ProTeX) for a Gridded Component can be accessed via the tag 'b_pchakrab_G20Udoc' (branched off from Ganymed-2_0_UNSTABLE).

$ cd $ESMADIR/src/GEOSgcs_GridComp/GEOSgcm_GridComp/GEOSagcm_GridComp/GEOSsuperdyn_GridComp/FVdycore_GridComp
$ cvs up -r b_pchakrab_G20Udoc FileName_GridCompMod.F90
$ cvs up -r b_pchakrab_G20Udoc GNUmakefile

GNUmakefile needs to be updated to reflect the 'correct' relative location of ESMADIR.

make doc

A 'make doc' in this GridComp directory creates the file 'FVdycore_GridComp.tex' in GEOSagcm/Linux/doc.

$ make doc

compile

This is a temporary method of compiling the resulting tex file.

Copy the two files GEOS_preamble.tex and make_doc from /discover/swdev/pchakrab/sandbox/AGCM/G20U_doc/GEOSagcm/Linux/doc into your Linux/doc.

$ cd $ESMADIR/Linux/doc
$ cp /discover/swdev/pchakrab/sandbox/AGCM/G20U_doc/GEOSagcm/Linux/doc/GEOS_preamble.tex .
$ cp /discover/swdev/pchakrab/sandbox/AGCM/G20U_doc/GEOSagcm/Linux/doc/make_doc .

Edit file make_doc to reflect the correct GridComp name (set TEXFILE = FVdycore_GridComp.tex) and compile

$ ./make_doc

This creates the file 'tmp.pdf'. On discover, xpdf is located at /usr/local/other/SLES11/xpdf/3.03-gcc-4.3.2/bin/xpdf.