| 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 |
|
=== WARNING : The following has been superseeded by the on-line === |
| 48 |
|
=== documentation at: http://mitgcm.org === |
| 49 |
|
====================================================================== |
| 50 |
|
|
| 51 |
|
|
| 52 |
MITgcmUV Getting Started |
MITgcmUV Getting Started |
| 53 |
======================== |
======================== |
| 54 |
|
|
| 55 |
o Introduction |
o Introduction |
| 56 |
|
|
| 57 |
o Install |
This note is a guide to using the MIT General Circulation Model Ultra Verstaile |
| 58 |
tar -xvf ... |
implementation, MITgmcUV. MITgcmUV is a Fortran code that implements the |
| 59 |
cd tools |
algorithm described in Marshall et. al. 1997, Hill, Adcroft, ... |
| 60 |
genmake.dec |
The MITgcmUV implementation is designed to work efficiently on all classes |
| 61 |
cd ../bin |
of computer platforms. It can be used in both a single processor mode |
| 62 |
ln -s ../tools/Makefile.dec makefile |
and a parallel processor mode. Parallel processing can be either multi-threaded |
| 63 |
make depend |
shared memory such as that found on CRAY T90 machines or it can be multi-process |
| 64 |
make |
distributed memory. A set of "execution enviroment" support routines are |
| 65 |
setenv PARALLEL 1 |
used to allow the same numerical code to run on top of a single-process, multi-threaded |
| 66 |
../exe/barrier |
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 |
|
tar -xvf cNN.tar |
| 76 |
|
|
| 77 |
|
2. Create platform specific make file |
| 78 |
|
For example on a Digital UNIX machine the script "genmake" can |
| 79 |
|
be used as shown below |
| 80 |
|
|
| 81 |
|
cd bin |
| 82 |
|
../tools/genmake |
| 83 |
|
cp Makefile.alpha Makefile ( On Alpha machine) |
| 84 |
|
|
| 85 |
|
3. Now create header file dependency entries |
| 86 |
|
make depend |
| 87 |
|
|
| 88 |
|
4. Compile code |
| 89 |
|
make |
| 90 |
|
|
| 91 |
|
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 |
|
|
| 95 |
|
|
| 96 |
o Running |
o Running |
| 97 |
|
|
| 98 |
eedata |
- Input and output files |
| 99 |
data |
|
| 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 |
|
|
| 109 |
- Serial execution |
- Serial execution |
| 110 |
|
|
| 111 |
|
- Parallel execution. MPI |
| 112 |
|
mPx, nPy |
| 113 |
|
dmpirun |
| 114 |
|
|
| 115 |
- Parallel execution. Threads |
- Parallel execution. Threads |
| 116 |
nSx, nSy |
nSx, nSy |
| 117 |
setenv PARALLEL n |
setenv PARALLEL n |
| 118 |
nTx=2, nTy=2 |
nTx=2, nTy=2 |
| 119 |
|
|
|
- Parallel execution. MPI |
|
|
mPx, nPy |
|
|
dmpirun |
|
|
|
|
| 120 |
- Parallel execution. Hybrid |
- Parallel execution. Hybrid |
| 121 |
|
|
| 122 |
o References |
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 |
|
|
| 145 |
|
o References |
| 146 |
|
Web sites - HP |
| 147 |
|
for doc Digital |
| 148 |
|
SGI |
| 149 |
|
Sun |
| 150 |
|
Linux threads |
| 151 |
|
CRAY multitasking |
| 152 |
|
PPT notes |
Parent Directory
| 
Revision Log
| 
Revision Graph
| 
Patch