/[MITgcm]/MITgcm/doc/devel_HOWTO.sgml
ViewVC logotype

Diff of /MITgcm/doc/devel_HOWTO.sgml

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.9 by jmc, Tue May 9 21:10:19 2006 UTC revision 1.10 by jmc, Thu Jan 21 23:59:17 2010 UTC
# Line 22  Line 22 
22            Initial version.            Initial version.
23          </revremark>          </revremark>
24        </revision>        </revision>
25          <revision>
26            <revnumber>0.02</revnumber>
27            <date>2010-01-21</date>
28            <authorinitials>jmc</authorinitials>
29            <revremark>
30              update links.
31            </revremark>
32          </revision>
33      </revhistory>      </revhistory>
34    
35      <abstract>      <abstract>
# Line 37  Line 45 
45      <sect2>      <sect2>
46        <title>New Versions of This Document</title> <para>You can        <title>New Versions of This Document</title> <para>You can
47        obtain the latest version of this document <ulink        obtain the latest version of this document <ulink
48        url="http://mitgcm.org/dev_docs/devel_HOWTO/">online</ulink> in        url="http://mitgcm.org/public/docs.html">online</ulink> in
49        various formats.</para>        various formats.</para>
50      </sect2>      </sect2>
51      <sect2>      <sect2>
# Line 56  Line 64 
64        <title>User Manual</title>        <title>User Manual</title>
65    
66        <para>Before jumping into development, please familiarize yourself with        <para>Before jumping into development, please familiarize yourself with
67          the <ulink url="http://mitgcm.org/docs.html"> MITgcm user manual          the <ulink url="http://mitgcm.org/public/docs.html"> MITgcm user manual
68          </ulink>.  This document contains volumes of useful information and is          </ulink>.  This document contains volumes of useful information and is
69          included here by reference.</para>          included here by reference.</para>
70    
# Line 130  Line 138 
138     e|- tools     e|- tools
139     ?|  tutorial_examples        documented tests     ?|  tutorial_examples        documented tests
140      |                             only populated on release1 branch      |                             only populated on release1 branch
141      |                             and not validated during "testscript"      |                             and not validated during "testreport"
142      '- utils      '- utils
143         verification             std tests         verification             std tests
144    
# Line 182  Line 190 
190        <title>Branches</title>        <title>Branches</title>
191    
192        <para>As shown in the online <ulink        <para>As shown in the online <ulink
193        url="http://dev.mitgcm.org/cgi-bin/viewcvs.cgi/MITgcm/doc/tag-index?graph=1.174">        url="http://mitgcm.org/viewvc/MITgcm/MITgcm/doc/tag-index?view=graph">
194        ViewCVS-generated tree</ulink>, the MITgcm codebase is split into to two        ViewCVS-generated tree</ulink>, the MITgcm codebase is split into to two
195        branches or "lines" under which development proceeds.  These two lines are        branches or "lines" under which development proceeds.  These two lines are
196        referred to as the "MAIN" and "ecco" versions of the code.  While not        referred to as the "MAIN" and "ecco" versions of the code.  While not
# Line 216  Line 224 
224    
225          <listitem>          <listitem>
226            <para>The developer then runs the <ulink            <para>The developer then runs the <ulink
227            url="http://dev.mitgcm.org/cgi-bin/viewcvs.cgi/MITgcm/verification/testscript">            url="http://mitgcm.org/viewvc/MITgcm/MITgcm/verification/testreport">
228            testscript</ulink> shell script to see if any problems are introduced.            testreport</ulink> shell script to see if any problems are introduced.
229            While not intended to be exhaustive, the test cases within the            While not intended to be exhaustive, the test cases within the
230            verification directory do provide some indication whether gross errors            verification directory do provide some indication whether gross errors
231            have been introduced.            have been introduced.
# Line 232  Line 240 
240              <listitem>              <listitem>
241                <para>adds a "checkpointXY_pre" comment (where X is a checkpoint                <para>adds a "checkpointXY_pre" comment (where X is a checkpoint
242                number and Y is a letter) to the <ulink                number and Y is a letter) to the <ulink
243                url="http://dev.mitgcm.org/cgi-bin/viewcvs.cgi/MITgcm/doc/tag-index">                url="http://mitgcm.org/viewvc/MITgcm/MITgcm/doc/tag-index">
244                tag-index</ulink> file and checks it into the CVS                tag-index</ulink> file and checks it into the CVS
245                repository</para>                repository</para>
246              </listitem>              </listitem>
# Line 787  checkpoint50d_pre Line 795  checkpoint50d_pre
795                special command option (see "-command" below) to invoke the MPI                special command option (see "-command" below) to invoke the MPI
796                executable.  Examples of PBS scripts using MPI with testreport can be                executable.  Examples of PBS scripts using MPI with testreport can be
797                found in the <ulink                found in the <ulink
798                url="http://dev.mitgcm.org/cgi-bin/viewcvs.cgi/MITgcm_contrib/test_scripts/">                url="http://mitgcm.org/viewvc/MITgcm/MITgcm_contrib/test_scripts/">
799                MITgcm-contrib area</ulink></para>                MITgcm-contrib area</ulink></para>
800              </listitem>              </listitem>
801            </varlistentry>            </varlistentry>
# Line 799  checkpoint50d_pre Line 807  checkpoint50d_pre
807                output.txt" is not sufficient.  This option allows a more general                output.txt" is not sufficient.  This option allows a more general
808                command (or shell script) to be invoked.  Examples of PBS scripts                command (or shell script) to be invoked.  Examples of PBS scripts
809                using MPI with testreport can be found in the <ulink                using MPI with testreport can be found in the <ulink
810                url="http://dev.mitgcm.org/cgi-bin/viewcvs.cgi/MITgcm_contrib/test_scripts/">                url="http://mitgcm.org/viewvc/MITgcm/MITgcm_contrib/test_scripts/">
811                MITgcm-contrib area</ulink></para>                MITgcm-contrib area</ulink></para>
812              </listitem>              </listitem>
813            </varlistentry>            </varlistentry>
Legend:
Removed from v.1.9  
changed lines
  Added in v.1.10
  ViewVC Help
Powered by ViewVC 1.1.22