| 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 |
======================== |
======================== |
| 75 |
tar -xvf cNN.tar |
tar -xvf cNN.tar |
| 76 |
|
|
| 77 |
2. Create platform specific make file |
2. Create platform specific make file |
| 78 |
For example on a Digital UNIX machine the script "genmake.dec" can |
For example on a Digital UNIX machine the script "genmake" can |
| 79 |
be used as shown below |
be used as shown below |
| 80 |
|
|
| 81 |
cd bin |
cd bin |
| 88 |
4. Compile code |
4. Compile code |
| 89 |
make |
make |
| 90 |
|
|
| 91 |
5. Copy input files |
5. To run the model with example data see the "README" in each of |
| 92 |
cp ../verification/exp2/[a-z]* ../verification/exp2/*bin . |
the example experiments in ../verification/exp*/ |
| 93 |
|
e.g. ../verification/exp2/README |
| 94 |
|
|
|
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. |
|
|
|
|
|
This 4 degree global ocean climatological simulation is the baseline |
|
|
configuration for the MITgcmUV code. The change files that |
|
|
convert the model to a different configuration in the |
|
|
verification directory all assume that the model is configured for |
|
|
the baseline case and change the model code accordingly. |
|
| 95 |
|
|
| 96 |
o Running |
o Running |
| 97 |
|
|
| 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 Cutomising the code |
o Cutomising the code |
Parent Directory
| 
Revision Log
| 
Revision Graph
| 
Patch