/[MITgcm]/MITgcm/doc/README
ViewVC logotype

Diff of /MITgcm/doc/README

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

revision 1.12 by cnh, Thu Jul 16 16:58:32 1998 UTC revision 1.16 by edhill, Fri Aug 22 14:30:41 2003 UTC
# Line 1  Line 1 
1  $Header$  $Header$
2    
3    ================
4    ===  WARNING ===
5    ================
6    
7    
8    For MITgcm Users :
9    
10    This directory (MITgcm/doc) does *NOT* contain the primary user
11    documentation for the MITgcm code.  We strongly suggest that you forgo
12    the effort of downloading and "building" the documentation in the
13    different formats (pdf, html, etc.) and instead read and/or download
14    the documentation which is conveniently referenced from the main web
15    site at:
16    
17      http://mitgcm.org
18    
19    
20    
21    For MITgcm Developers:
22    
23    If you wish to customize or extend the MITgcm code, this directory
24    contains a "HOWTO" document that tries to explain:
25    
26      + where the code, documentation, and test/verification
27        data sets are arranged within the CVS repository;
28    
29      + how to run the verification tests;
30    
31      + how to get help from the core developers; and
32    
33      + how to best integrate your work with the overall project.
34    
35    
36    The document is available in SGML source within this directory:
37    
38      devel_HOWTO.sgml
39    
40    and in various formats on our web site:
41    
42      http://mitgcm.org/dev_docs/devel_HOWTO/
43    
44    
45    
46    
47    ======================================================================
48    ===  WARNING :  The following has been superseeded by the on-line  ===
49    ===             documentation at:  http://mitgcm.org               ===
50    ======================================================================
51    
52    
53  MITgcmUV Getting Started  MITgcmUV Getting Started
54  ========================  ========================
# Line 24  o Installing Line 73  o Installing
73    the steps below:    the steps below:
74    
75    1. Extract MITgcmUV from the downloadable archive    1. Extract MITgcmUV from the downloadable archive
76       tar -xvf checkpoint12.tar       tar -xvf cNN.tar
77    
78    2. Create platform specific make file    2. Create platform specific make file
79       For example on a Digital UNIX machine the script "genmake.dec" can       For example on a Digital UNIX machine the script "genmake" can
80       be used as shown below       be used as shown below
81    
82       cd bin       cd bin
# Line 40  o Installing Line 89  o Installing
89    4. Compile code    4. Compile code
90       make       make
91    
92    5. Copy input files    5. To run the model with example data see the "README" in each of
93       cp ../verification/exp2/[a-z]* ../verification/exp2/*bin .       the example experiments in ../verification/exp*/
94         e.g.  ../verification/exp2/README
95        
   6. Run baseline test case  
      setenv PARALLEL 1  
      dmpirun -np 2 ../exe/mitgcmuv        ( Under Digital UNIX   )  
      mpirun.p4shmem ../exe/mitgcmuv -np 2 ( Under Solaris + mpich)  
                                                         
   
      This runs a 4 degree global ocean climatological simulation.  
      By default this code is set to use two processors splitting  
      the model domain along the equator. Textual output is written  
      to files STDOUT.* and STDERR.* with one file for each process.  
      Model fileds are written to files suffixed .data and .meta  
      These files are written on a per process basis. The .meta  
      file indicates the location and shape of the subdomain in  
      each .data file.  
96    
97  o Running  o Running
98    
# Line 73  o Running Line 109  o Running
109    
110    - Serial execution    - Serial execution
111    
112      - Parallel execution. MPI
113        mPx, nPy
114        dmpirun
115    
116    - Parallel execution. Threads    - Parallel execution. Threads
117      nSx, nSy      nSx, nSy
118      setenv PARALLEL n      setenv PARALLEL n
119      nTx=2, nTy=2      nTx=2, nTy=2
120    
   - Parallel execution. MPI  
     mPx, nPy  
     dmpirun  
   
121    - Parallel execution. Hybrid    - Parallel execution. Hybrid
122    
123  o Cutomising the code  o Cutomising the code

Legend:
Removed from v.1.12  
changed lines
  Added in v.1.16

  ViewVC Help
Powered by ViewVC 1.1.22