Documenting GEOS-5 Gridded Components: Difference between revisions

Line 1:

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).

==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 GEOSagcm/src/GEOSgcs_GridComp/GEOSgcm_GridComp/GEOSagcm_GridComp/GEOSsuperdyn_GridComp/FVdycore_GridComp

Line 10:

Line 12:

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==

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

Line 17:

Line 20:

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

==ProTeX guidelines==

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

@@ Line 1: / Line 1: @@
 Following list the steps to update documentation of Fvdycore_GridCompModMod.F90.
-. 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).
+==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 GEOSagcm/src/GEOSgcs_GridComp/GEOSgcm_GridComp/GEOSagcm_GridComp/GEOSsuperdyn_GridComp/FVdycore_GridComp
@@ Line 10: / Line 12: @@
-. 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==
+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
@@ Line 17: / Line 20: @@
-. For a guideline to generate documentation using ProTeX, please see [[ProTeX guidelines]].
+==ProTeX guidelines==
+For a guideline to generate documentation using ProTeX, please see [[ProTeX guidelines]].