Documenting GEOS-5 Gridded Components: Difference between revisions

From GEOS-5
Jump to navigation Jump to search
← Older edit
Pchakrab (talk | contribs)
1,048 edits
Pchakrab (talk | contribs)
1,048 edits
No edit summary
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
Following list the steps to update documentation of Fvdycore_GridCompModMod.F90.
{{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.
 
==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==
==Modified version of source file==
Line 5: Line 15:
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).
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
  $ 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 FileName_GridCompMod.F90
  $ cvs up -r b_pchakrab_G20Udoc GNUmakefile
  $ cvs up -r b_pchakrab_G20Udoc GNUmakefile
Line 12: Line 22:


==make doc==
==make doc==
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).
A 'make doc' in this GridComp directory creates the file 'FVdycore_GridComp.tex' in GEOSagcm/Linux/doc.


  $ ./make_doc
$ 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.
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==
[Temporary method of compiling the resulting tex file] Copy the two files GEOS_Preamble.tex and make_doc over into Linux/doc.


==ProTeX guidelines==
$ cd $ESMADIR/Linux/doc
For a guideline to generate documentation using ProTeX, please see [[ProTeX guidelines]].
$ 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
 
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.

Latest revision as of 12:54, 11 February 2013

Template:Delete

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

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

[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

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.

Retrieved from "https://geos5.org/wiki/index.php?title=Documenting_GEOS-5_Gridded_Components&oldid=1752"