1 | ###################################################################### |
---|
2 | |
---|
3 | -- Argonne National Laboratory |
---|
4 | |
---|
5 | Model Coupling Toolkit (MCT) |
---|
6 | |
---|
7 | Robert Jacob |
---|
8 | Jay Larson |
---|
9 | Everest Ong |
---|
10 | Ray Loy |
---|
11 | |
---|
12 | For more information, see http://www.mcs.anl.gov/mct |
---|
13 | |
---|
14 | See MCT/LICENSE for license. |
---|
15 | |
---|
16 | ###################################################################### |
---|
17 | |
---|
18 | This is version 2.10 of the Model Coupling Toolkit (MCT). |
---|
19 | |
---|
20 | Our purpose in creating this toolkit is to support the construction |
---|
21 | of highly portable and extensible high-performance couplers |
---|
22 | for distributed memory parallel coupled models. |
---|
23 | |
---|
24 | ###################################################################### |
---|
25 | |
---|
26 | |
---|
27 | Current Contents of the directory MCT: |
---|
28 | |
---|
29 | README -- this file |
---|
30 | |
---|
31 | LICENSE -- copyright statement and license. |
---|
32 | |
---|
33 | mct/ -- Source code for the Model Coupling Toolkit. |
---|
34 | |
---|
35 | mpeu/ -- Source code for the message-passing environment utilities |
---|
36 | library (MPEU), which provides support for MCT |
---|
37 | |
---|
38 | mpi-serial/ -- Source code for optional mpi replacement library. |
---|
39 | |
---|
40 | examples/-- Source code for examples which demonstrate the use of MCT. |
---|
41 | |
---|
42 | doc/ -- documentation for MCT |
---|
43 | |
---|
44 | protex/ -- tool for constructing documentation from source code |
---|
45 | |
---|
46 | data/ -- input data for running example programs. Not needed to |
---|
47 | compile the library. |
---|
48 | |
---|
49 | m4/ -- files for autoconf (not needed to build). |
---|
50 | |
---|
51 | Optional Contents available |
---|
52 | |
---|
53 | babel/ -- multi language interface for MCT using BABEL. |
---|
54 | See babel/README for more information. |
---|
55 | NO LONGER SUPPORTED |
---|
56 | |
---|
57 | ###################################################################### |
---|
58 | REQUIREMENTS: |
---|
59 | |
---|
60 | Building MCT requires a Fortran90 compiler. |
---|
61 | |
---|
62 | A full MPI library is now optional. To compile without MPI, add |
---|
63 | --enable-mpiserial to the configure command below. Note that |
---|
64 | not all the examples will work without MPI. See mpi-serial/README |
---|
65 | for more information. |
---|
66 | |
---|
67 | |
---|
68 | The MCT library builds and the examples run on the following |
---|
69 | platforms/compilers: |
---|
70 | |
---|
71 | Linux: Portland Group, Intel, gfortran, Absoft, Pathscale, Lahey, NAG |
---|
72 | MacOSX: gfortran |
---|
73 | IBM (AIX) xlf |
---|
74 | IBM BlueGene (see PLATFORM NOTE below) |
---|
75 | NEC |
---|
76 | Fujitsu |
---|
77 | |
---|
78 | Running some of the examples requires a full MPI installation with mpirun |
---|
79 | Memory requirements are modest. |
---|
80 | |
---|
81 | ###################################################################### |
---|
82 | BUILD INSTRUCTIONS: |
---|
83 | |
---|
84 | In the top level directory (the location of this README): |
---|
85 | > ./configure |
---|
86 | > make |
---|
87 | |
---|
88 | "make examples" will build the example programs. |
---|
89 | |
---|
90 | BUILD HELP: |
---|
91 | Try "./configure -help" for a list of options. |
---|
92 | |
---|
93 | The correct Fortran90 compiler must be in your current path. |
---|
94 | A frequent problem on Linux is when more than one F90 compiler |
---|
95 | is in your path and configure finds one and later finds mpif90 |
---|
96 | for another. |
---|
97 | |
---|
98 | Example: If configure has trouble finding the correct F90 compiler: |
---|
99 | > ./configure FC=pgf90. |
---|
100 | |
---|
101 | You can also direct configure through environment variables: |
---|
102 | > setenv FC xlf90 |
---|
103 | > ./configure |
---|
104 | |
---|
105 | If the build fails, please do the following: |
---|
106 | > ./configure >& config.out |
---|
107 | > make >& make.out |
---|
108 | and send us config.out, make.out and config.log (which is produced by the |
---|
109 | configure command) |
---|
110 | |
---|
111 | PLATFORM NOTES: |
---|
112 | On a BlueGene, use: |
---|
113 | > ./configure FC=bgxlf90_r CC=mpixlc_r MPIFC=mpixlf90_r (can also use versions without _r) |
---|
114 | |
---|
115 | ###################################################################### |
---|
116 | INSTALLATION INSTRUCTIONS: |
---|
117 | |
---|
118 | "make install" will copy the .mod files to the /usr/include directory |
---|
119 | and the *lib.a files to /usr/lib. To override these choices, use |
---|
120 | "-prefix" when running configure: |
---|
121 | > ./configure --prefix=/home/$USER |
---|
122 | With the above option, "make install" will place .mod's in /home/$USER/include |
---|
123 | and *lib.a's in /home/$USER/lib |
---|
124 | |
---|
125 | ###################################################################### |
---|
126 | BUILDING AND RUNNING THE EXAMPLES |
---|
127 | |
---|
128 | The programs in MCT/examples/simple require no input. |
---|
129 | |
---|
130 | The programs in MCT/examples/climate_concur1 and MCT/examples/climate_sequen1 |
---|
131 | require some input data in a directory called MCT/data. The dataset is available with MCT |
---|
132 | or separately from the website. |
---|
133 | |
---|
134 | To build them, type "make examples" in the top level directory or |
---|
135 | cd to examples and type "make". |
---|
136 | |
---|
137 | ###################################################################### |
---|
138 | |
---|
139 | Both MCT and MPEU source code are self-documenting. All modules |
---|
140 | and routines contain prologues that can be extracted and processed |
---|
141 | into LaTeX source code by the public-domain tool ProTeX. ProTeX is |
---|
142 | included in the MCT source and available from: |
---|
143 | http://gmao.gsfc.nasa.gov/software/protex/ |
---|
144 | |
---|
145 | You can build the documentation with protex and latex by following |
---|
146 | the directions in the doc directory. |
---|
147 | |
---|
148 | ###################################################################### |
---|
149 | |
---|
150 | REVISION HISTORY: |
---|
151 | |
---|
152 | 18 Oct, 2000 -- Initial prototype |
---|
153 | 09 Feb, 2001 -- working MxN transfer |
---|
154 | 27 Apr, 2001 -- Sparse Matrix Multiply |
---|
155 | 13 Jun, 2001 -- General Grid |
---|
156 | 23 Aug, 2001 -- Linux PGF90 port |
---|
157 | 14 Dec, 2001 -- PCM support |
---|
158 | 29 Mar, 2002 -- Rearranger |
---|
159 | 14 Nov, 2002 -- version 1.0.0 -- first public release |
---|
160 | 11 Feb, 2003 -- version 1.0.4 |
---|
161 | 12 Mar, 2003 -- version 1.0.5 |
---|
162 | 02 Apr, 2003 -- version 1.0.7 |
---|
163 | 03 Jul, 2003 -- version 1.0.9 |
---|
164 | 26 Aug, 2003 -- version 1.0.12 |
---|
165 | 12 Sep, 2003 -- version 1.0.14 |
---|
166 | 21 Jan, 2004 -- version 1.4.0 |
---|
167 | 05 Feb, 2004 -- version 1.6.0 |
---|
168 | 23 Apr, 2004 -- version 2.0.0 |
---|
169 | 18 May, 2004 -- version 2.0.1 |
---|
170 | 11 Jul, 2004 -- version 2.0.2 |
---|
171 | 19 Oct, 2004 -- version 2.0.3 (not released) |
---|
172 | 21 Jan, 2005 -- version 2.1.0 |
---|
173 | 01 Dec, 2005 -- version 2.2.0 |
---|
174 | 22 Apr, 2006 -- version 2.2.1 (not released) |
---|
175 | 08 Sep, 2006 -- version 2.2.2 |
---|
176 | 16 Oct, 2006 -- version 2.2.3 |
---|
177 | 10 Jan, 2007 -- version 2.3.0 |
---|
178 | 17 Aug, 2007 -- version 2.4.0 |
---|
179 | 21 Nov, 2007 -- version 2.4.1 |
---|
180 | 20 Dec, 2007 -- version 2.4.2 (not released) |
---|
181 | 21 Jan, 2008 -- version 2.4.3 (not released) |
---|
182 | 28 Jan, 2008 -- version 2.5.0 |
---|
183 | 20 May, 2008 -- version 2.5.1 |
---|
184 | 05 Mar, 2009 -- version 2.6.0 |
---|
185 | 05 Jan, 2010 -- version 2.7.0 (released only in CCSM4) |
---|
186 | 28 Feb, 2010 -- version 2.7.1 (released only in CESM1) |
---|
187 | 30 Nov, 2010 -- version 2.7.2 (released only in CESM1.0.3) |
---|
188 | 25 Jan, 2011 -- version 2.7.3 (not released) |
---|
189 | 07 Mar, 2012 -- version 2.7.4 (not released) |
---|
190 | 30 Apr, 2012 -- version 2.8.0 |
---|
191 | 05 Jul, 2012 -- version 2.8.1 (not released) |
---|
192 | 12 Sep, 2012 -- version 2.8.2 (not released) |
---|
193 | 16 Dec, 2012 -- version 2.8.3 |
---|
194 | 19 Jun, 2015 -- version 2.9.0 |
---|
195 | 19 Apr, 2018 -- version 2.10.0 |
---|
196 | 11 Feb, 2021 -- version 2.11.0 |
---|