Contents of /MITgcm/doc/README

$Header: /u/gcmpack/models/MITgcmUV/doc/README,v 1.6 1998/04/27 04:39:41 cnh Exp $

MITgcmUV Getting Started
========================

o Introduction

  This note is a guide to using the MIT General Circulation Model Ultra Verstaile
  implementation, MITgmcUV. MITgcmUV is a Fortran code that implements the 
  algorithm described in Marshall et. al. 1997, Hill, Adcroft, ...
   The MITgcmUV implementation is designed to work efficiently on all classes
  of computer platforms. It can be used in both a single processor mode
  and a parallel processor mode. Parallel processing can be either multi-threaded
  shared memory such as that found on CRAY T90 machines or it can be multi-process
  distributed memory. A set of "execution enviroment" support routines are 
  used to allow the same numerical code to run on top of a single-process, multi-threaded
  or distributed multi-process configuration.

o Installing
  To setup the model on a particular computer the code tree must be created
  and appropriate compile and run scripts set up. For some platforms
  the necessary scripts are included in the release - in this case follow
  the steps below:

  1. Extract MITgcmUV from the downloadable archive
     tar -xvf MITgcmUV.2.0.tar 

  2. Create platform specific make file
     For example on a Digital UNIX machine the script "genmake.dec" can
     be used as shown below

     cd MITgcmUV.2.0/tools
     genmake.dec
     cd ../bin
     ln -s ../tools/Makefile.dec makefile

  3. Now create header file dependency entries
     make depend

  4. Compile code
     make
  
  5. Run baseline test case
     setenv PARALLEL 1
     ../exe/MITgcmUV.2.0

o Running

  - Input and output files

    Required files
    ==============
    The model is configured to look for two files with fixed names.
    These files are called
     "eedata" and "data".
    The file eedata contains "execution environment" data. At present
    this consists of a specification of the number of threads to
    use in X and Y under multithreaded execution.

  - Serial execution

  - Parallel execution. Threads
    nSx, nSy
    setenv PARALLEL n
    nTx=2, nTy=2

  - Parallel execution. MPI
    mPx, nPy
    dmpirun

  - Parallel execution. Hybrid

o References
  Web sites - HP
  for doc     Digital
              SGI
              Sun
              Linux threads
              CRAY multitasking
              PPT notes
1	$Header: /u/gcmpack/models/MITgcmUV/doc/README,v 1.6 1998/04/27 04:39:41 cnh Exp $
2
3	MITgcmUV Getting Started
4	========================
5
6	o Introduction
7
8	This note is a guide to using the MIT General Circulation Model Ultra Verstaile
9	implementation, MITgmcUV. MITgcmUV is a Fortran code that implements the
10	algorithm described in Marshall et. al. 1997, Hill, Adcroft, ...
11	The MITgcmUV implementation is designed to work efficiently on all classes
12	of computer platforms. It can be used in both a single processor mode
13	and a parallel processor mode. Parallel processing can be either multi-threaded
14	shared memory such as that found on CRAY T90 machines or it can be multi-process
15	distributed memory. A set of "execution enviroment" support routines are
16	used to allow the same numerical code to run on top of a single-process, multi-threaded
17	or distributed multi-process configuration.
18
19	o Installing
20	To setup the model on a particular computer the code tree must be created
21	and appropriate compile and run scripts set up. For some platforms
22	the necessary scripts are included in the release - in this case follow
23	the steps below:
24
25	1. Extract MITgcmUV from the downloadable archive
26	tar -xvf MITgcmUV.2.0.tar
27
28	2. Create platform specific make file
29	For example on a Digital UNIX machine the script "genmake.dec" can
30	be used as shown below
31
32	cd MITgcmUV.2.0/tools
33	genmake.dec
34	cd ../bin
35	ln -s ../tools/Makefile.dec makefile
36
37	3. Now create header file dependency entries
38	make depend
39
40	4. Compile code
41	make
42
43	5. Run baseline test case
44	setenv PARALLEL 1
45	../exe/MITgcmUV.2.0
46
47	o Running
48
49	- Input and output files
50
51	Required files
52	==============
53	The model is configured to look for two files with fixed names.
54	These files are called
55	"eedata" and "data".
56	The file eedata contains "execution environment" data. At present
57	this consists of a specification of the number of threads to
58	use in X and Y under multithreaded execution.
59
60	- Serial execution
61
62	- Parallel execution. Threads
63	nSx, nSy
64	setenv PARALLEL n
65	nTx=2, nTy=2
66
67	- Parallel execution. MPI
68	mPx, nPy
69	dmpirun
70
71	- Parallel execution. Hybrid
72
73	o References
74	Web sites - HP
75	for doc Digital
76	SGI
77	Sun
78	Linux threads
79	CRAY multitasking
80	PPT notes