Warning, /doc/old_doc/README is written in an unsupported language. File is not indexed.
view on githubraw file Latest commit ad38444b on 2018-01-31 20:35:48 UTC
52d73078ea Ed H*0001 ================
0002 === WARNING ===
0003 ================
0004
0005
0006 For MITgcm Users :
0007
0008 This directory (MITgcm/doc) does *NOT* contain the primary user
0009 documentation for the MITgcm code. We strongly suggest that you forgo
0010 the effort of downloading and "building" the documentation in the
0011 different formats (pdf, html, etc.) and instead read and/or download
0012 the documentation which is conveniently referenced from the main web
0013 site at:
0014
0015 http://mitgcm.org
0016
0017
0018
0019 For MITgcm Developers:
0020
0021 If you wish to customize or extend the MITgcm code, this directory
0022 contains a "HOWTO" document that tries to explain:
0023
0024 + where the code, documentation, and test/verification
0025 data sets are arranged within the CVS repository;
0026
0027 + how to run the verification tests;
0028
0029 + how to get help from the core developers; and
0030
0031 + how to best integrate your work with the overall project.
0032
0033
0034 The document is available in SGML source within this directory:
0035
0036 devel_HOWTO.sgml
0037
0038 and in various formats on our web site:
0039
0040 http://mitgcm.org/dev_docs/devel_HOWTO/
0041
0042
0043
0044 ======================================================================
0045 === WARNING : The following has been superseeded by the on-line ===
0046 === documentation at: http://mitgcm.org ===
0047 ======================================================================
455e14887b Alis*0048
20cdfdc893 Chri*0049
9d203edd2a Chri*0050 MITgcmUV Getting Started
0051 ========================
f4510ea3a5 Chri*0052
0053 o Introduction
0054
8819901a4a Chri*0055 This note is a guide to using the MIT General Circulation Model Ultra Verstaile
0056 implementation, MITgmcUV. MITgcmUV is a Fortran code that implements the
0057 algorithm described in Marshall et. al. 1997, Hill, Adcroft, ...
0058 The MITgcmUV implementation is designed to work efficiently on all classes
0059 of computer platforms. It can be used in both a single processor mode
0060 and a parallel processor mode. Parallel processing can be either multi-threaded
0061 shared memory such as that found on CRAY T90 machines or it can be multi-process
0062 distributed memory. A set of "execution enviroment" support routines are
0063 used to allow the same numerical code to run on top of a single-process, multi-threaded
0064 or distributed multi-process configuration.
e945ef9dd3 Chri*0065
8819901a4a Chri*0066 o Installing
0067 To setup the model on a particular computer the code tree must be created
0068 and appropriate compile and run scripts set up. For some platforms
0069 the necessary scripts are included in the release - in this case follow
0070 the steps below:
0071
0072 1. Extract MITgcmUV from the downloadable archive
8c88443df3 Chri*0073 tar -xvf cNN.tar
8819901a4a Chri*0074
0075 2. Create platform specific make file
ab42872a05 Alis*0076 For example on a Digital UNIX machine the script "genmake" can
8819901a4a Chri*0077 be used as shown below
0078
2d8f0aef08 Chri*0079 cd bin
0080 ../tools/genmake
e6eddbb9f8 Chri*0081 cp Makefile.alpha Makefile ( On Alpha machine)
8819901a4a Chri*0082
0083 3. Now create header file dependency entries
0084 make depend
0085
0086 4. Compile code
0087 make
455e14887b Alis*0088
ab42872a05 Alis*0089 5. To run the model with example data see the "README" in each of
0090 the example experiments in ../verification/exp*/
0091 e.g. ../verification/exp2/README
ee84fe4ba2 Chri*0092
8819901a4a Chri*0093
0094 o Running
0095
0096 - Input and output files
0097
0098 Required files
0099 ==============
0100 The model is configured to look for two files with fixed names.
0101 These files are called
0102 "eedata" and "data".
0103 The file eedata contains "execution environment" data. At present
0104 this consists of a specification of the number of threads to
0105 use in X and Y under multithreaded execution.
ee84fe4ba2 Chri*0106
0107 - Serial execution
0108
ab42872a05 Alis*0109 - Parallel execution. MPI
0110 mPx, nPy
0111 dmpirun
0112
ee84fe4ba2 Chri*0113 - Parallel execution. Threads
0114 nSx, nSy
0115 setenv PARALLEL n
0116 nTx=2, nTy=2
0117
0118 - Parallel execution. Hybrid
0119
2916d2c161 Chri*0120 o Cutomising the code
0121
0122 Model structure
0123 ===============
0124 The "numerical" model is contained within a execution
0125 environment support wrapper. This wrapper is designed
0126 to provide a general framework for grid-point models.
0127 MITgcmUV is a specific numerical model that uses the
0128 framework.
0129 Under this structure the model is split into
0130 execution environment support code and conventional
0131 numerical model code. The execution environment
0132 support code is held under the "eesupp" directory.
0133 The grid point model code is held under the
0134 "model" directory.
0135 Code execution actually starts in the eesupp
0136 routines and not in the model routines. For this
0137 reason the top level main.F is in the eesupp/src
0138 directory. End-users should not need to worry about
0139 this level. The top-level routine for the numerical
0140 part of the code is in model/src/the_model_main.F.
0141
0142
f4510ea3a5 Chri*0143 o References
eea639b8fc Chri*0144 Web sites - HP
0145 for doc Digital
0146 SGI
0147 Sun
0148 Linux threads
0149 CRAY multitasking
8819901a4a Chri*0150 PPT notes
