| 1 | ###################################################################### |
|---|
| 2 | |
|---|
| 3 | -- Mathematics + Computer Science Div. / Argonne National Laboratory |
|---|
| 4 | |
|---|
| 5 | Model Coupling Toolkit (MCT) |
|---|
| 6 | |
|---|
| 7 | Jay Larson |
|---|
| 8 | Robert Jacob |
|---|
| 9 | Everest Ong |
|---|
| 10 | Ray Loy |
|---|
| 11 | |
|---|
| 12 | For more information, see http://www.mcs.anl.gov/mct |
|---|
| 13 | |
|---|
| 14 | See MCT/COPYRIGHT for license. |
|---|
| 15 | |
|---|
| 16 | ###################################################################### |
|---|
| 17 | |
|---|
| 18 | This is version 2.8 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 | COPYRIGHT - 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 | |
|---|
| 56 | ###################################################################### |
|---|
| 57 | REQUIREMENTS: |
|---|
| 58 | |
|---|
| 59 | Building MCT requires a Fortran90 compiler. |
|---|
| 60 | |
|---|
| 61 | An MPI library is now optional. To compile without MPI, add |
|---|
| 62 | --enable-mpiserial to the configure command below. Note that |
|---|
| 63 | not all the examples will work without MPI. See mpi-serial/README |
|---|
| 64 | for more information. |
|---|
| 65 | |
|---|
| 66 | |
|---|
| 67 | The MCT library builds and the examples run on the following |
|---|
| 68 | platforms/compilers: |
|---|
| 69 | |
|---|
| 70 | Linux: Portland Group, Intel, gfortran, Absoft, Pathscale, Lahey, NAG |
|---|
| 71 | MacOSX: gfortran |
|---|
| 72 | IBM (AIX) xlf |
|---|
| 73 | IBM BlueGene (see PLATFORM NOTE below) |
|---|
| 74 | SGI Altix |
|---|
| 75 | Cray XT/XK |
|---|
| 76 | Compaq Compaq Fortran Compiler (X5.5-2801-48CAG or later) |
|---|
| 77 | SUN (Solaris) f90 WorkShop |
|---|
| 78 | NEC |
|---|
| 79 | Fujitsu |
|---|
| 80 | |
|---|
| 81 | Running some of the examples requires a parallel platform. |
|---|
| 82 | Memory requirements are modest. |
|---|
| 83 | |
|---|
| 84 | ###################################################################### |
|---|
| 85 | BUILD INSTRUCTIONS: |
|---|
| 86 | |
|---|
| 87 | In the top level directory (the location of this README): |
|---|
| 88 | > ./configure |
|---|
| 89 | > make |
|---|
| 90 | |
|---|
| 91 | "make examples" will build the example programs. |
|---|
| 92 | |
|---|
| 93 | BUILD HELP: |
|---|
| 94 | Try "./configure -help" for a list of options. |
|---|
| 95 | |
|---|
| 96 | The correct Fortran90 compiler must be in your current path. |
|---|
| 97 | A frequent problem on Linux is when more than one F90 compiler |
|---|
| 98 | is in your path and configure finds one and later finds mpif90 |
|---|
| 99 | for another. |
|---|
| 100 | |
|---|
| 101 | Example: If configure has trouble finding the correct F90 compiler: |
|---|
| 102 | > ./configure FC=pgf90. |
|---|
| 103 | |
|---|
| 104 | You can also direct configure through environment variables: |
|---|
| 105 | > setenv FC xlf90 |
|---|
| 106 | > ./configure |
|---|
| 107 | |
|---|
| 108 | If the build fails, please do the following: |
|---|
| 109 | > ./configure >& config.out |
|---|
| 110 | > make >& make.out |
|---|
| 111 | and send us config.out, make.out and config.log (which is produced by the |
|---|
| 112 | configure command) |
|---|
| 113 | |
|---|
| 114 | PLATFORM NOTES: |
|---|
| 115 | On a BlueGene/P, use: |
|---|
| 116 | > ./configure FC=bgxlf90_r CC=mpixlc_r MPIFC=mpixlf90_r (can also use versions without _r) |
|---|
| 117 | At ALCF, one can just type "./configure". |
|---|
| 118 | |
|---|
| 119 | On the Cray X* (e.g. jaguar) use: |
|---|
| 120 | > ./configure --host=Linux FC=ftn MPIFC=ftn |
|---|
| 121 | |
|---|
| 122 | ###################################################################### |
|---|
| 123 | INSTALLATION INSTRUCTIONS: |
|---|
| 124 | |
|---|
| 125 | "make install" will copy the .mod files to the /usr/include directory |
|---|
| 126 | and the *lib.a files to /usr/lib. To override these choices, use |
|---|
| 127 | "-prefix" when running configure: |
|---|
| 128 | > ./configure --prefix=/home/$USER |
|---|
| 129 | With the above option, "make install" will place .mod's in /home/$USER/include |
|---|
| 130 | and *lib.a's in /home/$USER/lib |
|---|
| 131 | |
|---|
| 132 | ###################################################################### |
|---|
| 133 | BUILDING AND RUNNING THE EXAMPLES |
|---|
| 134 | |
|---|
| 135 | The programs in MCT/examples/simple require no input. |
|---|
| 136 | |
|---|
| 137 | The programs in MCT/examples/climate_concur1 and MCT/examples/climate_sequen1 |
|---|
| 138 | require some input data in a directory called MCT/data. The dataset is available with MCT |
|---|
| 139 | or separately from the website. |
|---|
| 140 | |
|---|
| 141 | To build them, type "make examples" in the top level directory or |
|---|
| 142 | cd to examples and type "make". |
|---|
| 143 | |
|---|
| 144 | ###################################################################### |
|---|
| 145 | |
|---|
| 146 | Both MCT and MPEU source code are self-documenting. All modules |
|---|
| 147 | and routines contain prologues that can be extracted and processed |
|---|
| 148 | into LaTeX source code by the public-domain tool ProTeX. ProTeX is |
|---|
| 149 | available by anonymous ftp from: |
|---|
| 150 | |
|---|
| 151 | Software: |
|---|
| 152 | ftp://dao.gsfc.nasa.gov/pub/papers/sawyer/protex1.4.tar.Z |
|---|
| 153 | Documentation: |
|---|
| 154 | ftp://dao.gsfc.nasa.gov/pub/office_notes/on9711r0.ps.Z |
|---|
| 155 | |
|---|
| 156 | You can build the documentation with protex and latex by following |
|---|
| 157 | the directions in the doc directory. |
|---|
| 158 | |
|---|
| 159 | ###################################################################### |
|---|
| 160 | |
|---|
| 161 | REVISION HISTORY: |
|---|
| 162 | |
|---|
| 163 | 18 Oct, 2000 -- Initial prototype |
|---|
| 164 | 09 Feb, 2001 -- working MxN transfer |
|---|
| 165 | 27 Apr, 2001 -- Sparse Matrix Multiply |
|---|
| 166 | 13 Jun, 2001 -- General Grid |
|---|
| 167 | 23 Aug, 2001 -- Linux PGF90 port |
|---|
| 168 | 14 Dec, 2001 -- PCM support |
|---|
| 169 | 29 Mar, 2002 -- Rearranger |
|---|
| 170 | 14 Nov, 2002 -- version 1.0.0 -- first public release |
|---|
| 171 | 11 Feb, 2003 -- version 1.0.4 |
|---|
| 172 | 12 Mar, 2003 -- version 1.0.5 |
|---|
| 173 | 02 Apr, 2003 -- version 1.0.7 |
|---|
| 174 | 03 Jul, 2003 -- version 1.0.9 |
|---|
| 175 | 26 Aug, 2003 -- version 1.0.12 |
|---|
| 176 | 12 Sep, 2003 -- version 1.0.14 |
|---|
| 177 | 21 Jan, 2004 -- version 1.4.0 |
|---|
| 178 | 05 Feb, 2004 -- version 1.6.0 |
|---|
| 179 | 23 Apr, 2004 -- version 2.0.0 |
|---|
| 180 | 18 May, 2004 -- version 2.0.1 |
|---|
| 181 | 11 Jul, 2004 -- version 2.0.2 |
|---|
| 182 | 19 Oct, 2004 -- version 2.0.3 (not released) |
|---|
| 183 | 21 Jan, 2005 -- version 2.1.0 |
|---|
| 184 | 01 Dec, 2005 -- version 2.2.0 |
|---|
| 185 | 22 Apr, 2006 -- version 2.2.1 (not released) |
|---|
| 186 | 08 Sep, 2006 -- version 2.2.2 |
|---|
| 187 | 16 Oct, 2006 -- version 2.2.3 |
|---|
| 188 | 10 Jan, 2007 -- version 2.3.0 |
|---|
| 189 | 17 Aug, 2007 -- version 2.4.0 |
|---|
| 190 | 21 Nov, 2007 -- version 2.4.1 |
|---|
| 191 | 20 Dec, 2007 -- version 2.4.2 (not released) |
|---|
| 192 | 21 Jan, 2008 -- version 2.4.3 (not released) |
|---|
| 193 | 28 Jan, 2008 -- version 2.5.0 |
|---|
| 194 | 20 May, 2008 -- version 2.5.1 |
|---|
| 195 | 05 Mar, 2009 -- version 2.6.0 |
|---|
| 196 | 05 Jan, 2010 -- version 2.7.0 (released only in CCSM4) |
|---|
| 197 | 28 Feb, 2010 -- version 2.7.1 (released only in CESM1) |
|---|
| 198 | 30 Nov, 2010 -- version 2.7.2 (released only in CESM1.0.3) |
|---|
| 199 | 25 Jan, 2011 -- version 2.7.3 (not released) |
|---|
| 200 | 07 Mar, 2012 -- version 2.7.4 (not released) |
|---|
| 201 | 30 Apr, 2012 -- version 2.8.0 |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | Tag MCT_2_8_0 |
|---|
| 205 | README,v 1.49 2012-04-27 21:52:58 jacob Exp |
|---|
| 206 | |
|---|
