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

Annotation of /MITgcm/doc/README

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

Revision 1.17 - (hide annotations) (download)
Tue Apr 5 20:48:20 2005 UTC (19 years ago) by gforget
Branch: MAIN
CVS Tags: checkpoint62v, checkpoint57m_post, checkpoint62u, checkpoint57g_pre, checkpoint62t, checkpoint57s_post, checkpoint58b_post, checkpoint57g_post, checkpoint57y_post, checkpoint65z, checkpoint65x, checkpoint65y, checkpoint65r, checkpoint65s, checkpoint65p, checkpoint65q, checkpoint65v, checkpoint65w, checkpoint65t, checkpoint65u, checkpoint65j, checkpoint65k, checkpoint65h, checkpoint65i, checkpoint65n, checkpoint65l, checkpoint65m, checkpoint65b, checkpoint65c, checkpoint65a, checkpoint65f, checkpoint65g, checkpoint65d, checkpoint65e, checkpoint62c, checkpoint57r_post, checkpoint57i_post, checkpoint59, checkpoint58, checkpoint58f_post, checkpoint57n_post, checkpoint58d_post, checkpoint62s, checkpoint58a_post, checkpoint62r, checkpoint62q, checkpoint62p, checkpoint57z_post, checkpoint62a, checkpoint62g, checkpoint62f, checkpoint62e, checkpoint62d, checkpoint62k, checkpoint62j, checkpoint62i, checkpoint62h, checkpoint62o, checkpoint62n, checkpoint62m, checkpoint62l, checkpoint62w, checkpoint62z, checkpoint62y, checkpoint62x, checkpoint58y_post, checkpoint58t_post, checkpoint58m_post, checkpoint57l_post, checkpoint57t_post, checkpoint63g, checkpoint57v_post, checkpoint57f_post, checkpoint64, checkpoint65, checkpoint60, checkpoint61, checkpoint62, checkpoint63, checkpoint57h_pre, checkpoint66g, checkpoint66f, checkpoint66e, checkpoint66d, checkpoint66c, checkpoint66b, checkpoint66a, checkpoint66o, checkpoint66n, checkpoint66m, checkpoint66l, checkpoint66k, checkpoint66j, checkpoint66i, checkpoint66h, checkpoint58w_post, checkpoint57h_post, checkpoint57y_pre, checkpoint58o_post, checkpoint58p_post, checkpoint58q_post, checkpoint58e_post, checkpoint63p, checkpoint63q, checkpoint63r, checkpoint63s, checkpoint63l, checkpoint63m, checkpoint63n, checkpoint63o, checkpoint63h, checkpoint63i, checkpoint63j, checkpoint63k, checkpoint63d, checkpoint63e, checkpoint63f, checkpoint63a, checkpoint63b, checkpoint63c, checkpoint58r_post, checkpoint58n_post, checkpoint65o, checkpoint59q, checkpoint59p, checkpoint59r, checkpoint59e, checkpoint59d, checkpoint59g, checkpoint59f, checkpoint59a, checkpoint59c, checkpoint59b, checkpoint59m, checkpoint59l, checkpoint59o, checkpoint59n, checkpoint59i, checkpoint59h, checkpoint59k, checkpoint57p_post, checkpint57u_post, checkpoint57q_post, checkpoint58k_post, checkpoint62b, checkpoint58v_post, checkpoint64y, checkpoint64x, checkpoint58l_post, checkpoint64z, checkpoint64q, checkpoint64p, checkpoint64s, checkpoint64r, checkpoint64u, checkpoint64t, checkpoint64w, checkpoint64v, checkpoint64i, checkpoint64h, checkpoint64k, checkpoint64j, checkpoint64m, checkpoint64l, checkpoint64o, checkpoint64n, checkpoint64a, checkpoint64c, checkpoint64b, checkpoint64e, checkpoint64d, checkpoint64g, checkpoint64f, checkpoint57h_done, checkpoint57j_post, checkpoint57f_pre, checkpoint61f, checkpoint58g_post, checkpoint58x_post, checkpoint61n, checkpoint59j, checkpoint58h_post, checkpoint58j_post, checkpoint57o_post, checkpoint61q, checkpoint57k_post, checkpoint57w_post, checkpoint61e, checkpoint58i_post, checkpoint57x_post, checkpoint58c_post, checkpoint58u_post, checkpoint58s_post, checkpoint61g, checkpoint61d, checkpoint61b, checkpoint61c, checkpoint61a, checkpoint61o, checkpoint61l, checkpoint61m, checkpoint61j, checkpoint61k, checkpoint61h, checkpoint61i, checkpoint61v, checkpoint61w, checkpoint61t, checkpoint61u, checkpoint61r, checkpoint61s, checkpoint61p, checkpoint61z, checkpoint61x, checkpoint61y, HEAD
Changes since 1.16: +1 -2 lines 
 o delete line
1 gforget 1.17 $Header: /u/gcmpack/MITgcm/doc/README,v 1.16 2003/08/22 14:30:41 edhill Exp $
2 edhill 1.16
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     === WARNING : The following has been superseeded by the on-line ===
48     === documentation at: http://mitgcm.org ===
49     ======================================================================
50 adcroft 1.8
51 cnh 1.2
52 cnh 1.1 MITgcmUV Getting Started
53     ========================
54 cnh 1.3
55     o Introduction
56 cnh 1.4
57 cnh 1.7 This note is a guide to using the MIT General Circulation Model Ultra Verstaile
58     implementation, MITgmcUV. MITgcmUV is a Fortran code that implements the
59     algorithm described in Marshall et. al. 1997, Hill, Adcroft, ...
60     The MITgcmUV implementation is designed to work efficiently on all classes
61     of computer platforms. It can be used in both a single processor mode
62     and a parallel processor mode. Parallel processing can be either multi-threaded
63     shared memory such as that found on CRAY T90 machines or it can be multi-process
64     distributed memory. A set of "execution enviroment" support routines are
65     used to allow the same numerical code to run on top of a single-process, multi-threaded
66     or distributed multi-process configuration.
67    
68     o Installing
69     To setup the model on a particular computer the code tree must be created
70     and appropriate compile and run scripts set up. For some platforms
71     the necessary scripts are included in the release - in this case follow
72     the steps below:
73    
74     1. Extract MITgcmUV from the downloadable archive
75 cnh 1.14 tar -xvf cNN.tar
76 cnh 1.7
77     2. Create platform specific make file
78 adcroft 1.15 For example on a Digital UNIX machine the script "genmake" can
79 cnh 1.7 be used as shown below
80    
81 cnh 1.9 cd bin
82     ../tools/genmake
83 cnh 1.10 cp Makefile.alpha Makefile ( On Alpha machine)
84 cnh 1.7
85     3. Now create header file dependency entries
86     make depend
87    
88     4. Compile code
89     make
90 adcroft 1.8
91 adcroft 1.15 5. To run the model with example data see the "README" in each of
92     the example experiments in ../verification/exp*/
93     e.g. ../verification/exp2/README
94 cnh 1.7
95 cnh 1.5
96     o Running
97 cnh 1.7
98     - Input and output files
99    
100     Required files
101     ==============
102     The model is configured to look for two files with fixed names.
103     These files are called
104     "eedata" and "data".
105     The file eedata contains "execution environment" data. At present
106     this consists of a specification of the number of threads to
107     use in X and Y under multithreaded execution.
108 cnh 1.5
109     - Serial execution
110    
111 adcroft 1.15 - Parallel execution. MPI
112     mPx, nPy
113     dmpirun
114    
115 cnh 1.5 - Parallel execution. Threads
116     nSx, nSy
117     setenv PARALLEL n
118     nTx=2, nTy=2
119    
120     - Parallel execution. Hybrid
121 cnh 1.11
122     o Cutomising the code
123    
124     Model structure
125     ===============
126     The "numerical" model is contained within a execution
127     environment support wrapper. This wrapper is designed
128     to provide a general framework for grid-point models.
129     MITgcmUV is a specific numerical model that uses the
130     framework.
131     Under this structure the model is split into
132     execution environment support code and conventional
133     numerical model code. The execution environment
134     support code is held under the "eesupp" directory.
135     The grid point model code is held under the
136     "model" directory.
137     Code execution actually starts in the eesupp
138     routines and not in the model routines. For this
139     reason the top level main.F is in the eesupp/src
140     directory. End-users should not need to worry about
141     this level. The top-level routine for the numerical
142     part of the code is in model/src/the_model_main.F.
143    
144 cnh 1.3
145     o References
146 cnh 1.6 Web sites - HP
147     for doc Digital
148     SGI
149     Sun
150     Linux threads
151     CRAY multitasking
152 cnh 1.7 PPT notes
  ViewVC Help
Powered by ViewVC 1.1.22