/[MITgcm]/mitgcm.org/front_content/docs.xml
ViewVC logotype

Diff of /mitgcm.org/front_content/docs.xml

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

revision 1.8 by heimbach, Tue Jan 15 15:44:53 2008 UTC revision 1.14 by jmc, Fri Jan 19 17:20:19 2018 UTC
# Line 22  Line 22 
22    
23    <body>            <body>        
24    
25      <p>Multiple sources of documentation are currently available:      <p>Several documents are currently available:
26        <ul>        <ul>
27    
28          <li>The complete <a href="http://eddy.csail.mit.edu/r2/latest/">MITgcm User's          <li>The <a href="r2_manual/latest/">
29              Manual</a><br /><br /></li>              most recent </a> online documentation <br /><br /></li>
30    
31          <li>An MITgcm "Developer's HOWTO" is available in multiple formats:          <li>The
32               <a href="sealion/"> Release-1
33                </a> online documentation (stable) <br /><br /></li>
34    
35            <li> Our
36                <a href="r2_manual/latest/code_reference/callTree.html" >on-line
37                code browser</a> provides a view of the various
38                subroutines, functions and variables,
39                showing how they are called and used.<br /><br /></li>
40            
41            <li>An MITgcm "Developer's HOWTO" manual is available in multiple formats:
42            <ul>            <ul>
43              <li><a href="./devel_HOWTO/devel_HOWTO_onepage/"> Single-page              <li><a href="./devel_HOWTO/devel_HOWTO_onepage/"> Single-page
44                  HTML</a></li>                  </a> or
45              <li><a href="./devel_HOWTO/devel_HOWTO_multipage/"> Multi-page              <a href="./devel_HOWTO/devel_HOWTO_multipage/"> Multi-page
46                  HTML</a></li>                  </a> (html) </li>
47              <li><a href="./devel_HOWTO/devel_HOWTO.pdf"> PDF file </a></li>              <li><a href="./devel_HOWTO/devel_HOWTO.pdf"> PDF file </a> or
48              <li><a href="./devel_HOWTO/devel_HOWTO.pdf"> PostScript file              <a href="./devel_HOWTO/devel_HOWTO.ps"> PostScript file
49                  </a></li>                  </a></li>
50            </ul>            </ul>
51            <br />          <br /></li>
         </li>  
           
         <li>An <a href="http://mitgcm.org/sealion/">MITgcm API Reference  
             Manual</a> is also available.  It provides a view of the various  
             subroutines, functions, variables, showing how they are called and  
             used.  Used in conjunction with our <a  
             href="http://mitgcm.org/cmi_redir.php/code_browser"> on-line code  
             browser</a>, the API Reference can be helpful when trying to  
             understand parts of the MITgcm internals. <br /><br /></li>  
52                    
53            <li>New: Documentation is getting reformatted into sphinx/rst format and hosted at
54              <a href="https://mitgcm-example.readthedocs.io/en/latest/"> readthedocs</a>.
55              Note that the conversion from the old manual is currently under way
56              so that this new document is not yet complete.
57              Both the new documentation source files and the associated
58              -- but currently frozen -- MITgcm code
59              are available from a single
60              <a href="https://github.com/altMITgcm/MITgcm"> prototype repository</a>
61              on GitHub. This repository is used to explore a transition from CVS to Git
62              which is planned to happen soon.
63            <br /><br /></li>
64    
65        </ul>        </ul>
66      </p>      </p>
67    
68           <p>Papers charting the development of MITgcm <a
69                 href="http://mitgcm.org/publications/">can be found here.
70                       </a>
71           </p>
72    
73                    
74    </body>    </body>
75  </html>  </html>
Legend:
Removed from v.1.8  
changed lines
  Added in v.1.14
  ViewVC Help
Powered by ViewVC 1.1.22