Documenting GEOS-5 Gridded Components: Difference between revisions
Created page with "Following list the steps to update documentation of Fvdycore_GridCompModMod.F90. 1. The modified version of the source file (that works with ProTeX) for a Gridded Component can ..." |
No edit summary |
||
| Line 14: | Line 14: | ||
$ ./make_doc | $ ./make_doc | ||
This create the tmp.pdf file. | This create the tmp.pdf file. On discover xpdf is located at /usr/local/other/SLES11/xpdf/3.03-gcc-4.3.2/bin/xpdf. | ||
3. For a guideline to generate documentation using ProTeX, please see [[ProTeX guidelines]]. | 3. For a guideline to generate documentation using ProTeX, please see [[ProTeX guidelines]]. | ||
Revision as of 09:53, 2 January 2013
Following list the steps to update documentation of Fvdycore_GridCompModMod.F90.
1. 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 GEOSagcm/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.
2. A 'make doc' in this GridComp directory creates the file 'FVdycore_GridComp.tex' in GEOSagcm/Linux/doc. To compile it, copy the two files GEOS_preamble.tex and make_doc from /discover/swdev/pchakrab/sandbox/AGCM/G20U_doc/GEOSagcm/Linux/doc into Linux/doc. Edit file make_doc to reflect the correct GridComp name (e.g. FVdycore_GridComp.tex instead of FVdycoreCubed_GridComp.tex).
$ ./make_doc
This create the tmp.pdf file. On discover xpdf is located at /usr/local/other/SLES11/xpdf/3.03-gcc-4.3.2/bin/xpdf.
3. For a guideline to generate documentation using ProTeX, please see ProTeX guidelines.