Documenting GEOS-5 Gridded Components: Difference between revisions
No edit summary |
|||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{delete | [I do not need this page anymore - Purnendu.] }} | |||
{{rightTOC}} | |||
Steps to update GEOS-5 documentation. As an example, we consider the GridComp FVdycore_GridComp. | Steps to update GEOS-5 documentation. As an example, we consider the GridComp FVdycore_GridComp. | ||
| Line 22: | Line 25: | ||
$ make doc | $ make doc | ||
If make complains about not being able to find ESMA_base.mk etc., edit GNUmakefile so that ESMADIR points to the directory containing Linux, src etc. | |||
==compile== | ==compile== | ||
[Temporary method of compiling the resulting tex file] Copy the two files GEOS_Preamble.tex and make_doc over into Linux/doc. | |||
$ cd $ESMADIR/Linux/doc | |||
$ cp /discover/swdev/pchakrab/scratch/doc/GEOS_Preamble.tex . | |||
$ cp /discover/swdev/pchakrab/scratch/doc/make_doc.csh . | |||
Edit file make_doc.csh to reflect the correct GridComp name (set TEXFILE = FVdycore_GridComp.tex) and compile | |||
$ ./make_doc.csh | |||
$ ./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. | 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. | ||