/[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.3 by cnh, Fri Apr 24 03:55:30 1998 UTC revision 1.8 by adcroft, Mon Jun 22 16:24:50 1998 UTC
# Line 1  Line 1 
1  $Header$  $Header$
2    
3    
4  MITgcmUV Getting Started  MITgcmUV Getting Started
5  ========================  ========================
6    
7  o Introduction  o Introduction
8    
9  o References    This note is a guide to using the MIT General Circulation Model Ultra Verstaile
10      implementation, MITgmcUV. MITgcmUV is a Fortran code that implements the
11      algorithm described in Marshall et. al. 1997, Hill, Adcroft, ...
12       The MITgcmUV implementation is designed to work efficiently on all classes
13      of computer platforms. It can be used in both a single processor mode
14      and a parallel processor mode. Parallel processing can be either multi-threaded
15      shared memory such as that found on CRAY T90 machines or it can be multi-process
16      distributed memory. A set of "execution enviroment" support routines are
17      used to allow the same numerical code to run on top of a single-process, multi-threaded
18      or distributed multi-process configuration.
19    
20    o Installing
21      To setup the model on a particular computer the code tree must be created
22      and appropriate compile and run scripts set up. For some platforms
23      the necessary scripts are included in the release - in this case follow
24      the steps below:
25    
26      1. Extract MITgcmUV from the downloadable archive
27         tar -xvf MITgcmUV.2.0.tar
28    
29      2. Create platform specific make file
30         For example on a Digital UNIX machine the script "genmake.dec" can
31         be used as shown below
32    
33         cd MITgcmUV.2.0/tools
34         genmake.dec
35         cd ../bin
36         ln -s ../tools/Makefile.dec makefile
37    
38      3. Now create header file dependency entries
39         make depend
40    
41      4. Compile code
42         make
43    
44      5. Copy input files
45         cp ../verification/exp2/[a-z]* .
46      
47      6. Run baseline test case
48         setenv PARALLEL 1
49         ../exe/mitgcmuv
50    
51         This runs a 4 degree global ocean climatological simulation.
52         By default this code is set to use two porcessors splitting
53         the model domain along the equator. Textual output is written
54         to files STDOUT.* and STDERR.* with one file for each process.
55         Model fileds are written to files suffixed .data and .meta
56         These files are written on a per process basis. The .meta
57         file indicates the location and shape of the subdomain in
58         each .data file.
59    
60    o Running
61    
62      - Input and output files
63    
64        Required files
65        ==============
66        The model is configured to look for two files with fixed names.
67        These files are called
68         "eedata" and "data".
69        The file eedata contains "execution environment" data. At present
70        this consists of a specification of the number of threads to
71        use in X and Y under multithreaded execution.
72    
73      - Serial execution
74    
75      - Parallel execution. Threads
76        nSx, nSy
77        setenv PARALLEL n
78        nTx=2, nTy=2
79    
80      - Parallel execution. MPI
81        mPx, nPy
82        dmpirun
83    
84      - Parallel execution. Hybrid
85    
86    o References
87      Web sites - HP
88      for doc     Digital
89                  SGI
90                  Sun
91                  Linux threads
92                  CRAY multitasking
93                  PPT notes

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.8

  ViewVC Help
Powered by ViewVC 1.1.22