Changes between Version 44 and Version 45 of Users/ModelInstall
- Timestamp:
- 2017-05-17T15:56:48+02:00 (7 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Users/ModelInstall
v44 v45 17 17 == 1. Extract the NEMO code 18 18 19 Using your [[span(my_login, style=color: #BB4444 )]] /pw registered here:19 Using your account registered here ([[span('my_login', style=color: #BB4444 )]] with password) 20 20 {{{#!sh 21 21 svn --username 'mylogin' co http://forge.ipsl.jussieu.fr/nemo/svn/branches/2015/nemo_v3_6_STABLE/NEMOGCM 22 22 }}} 23 23 24 === Description of directory tree24 === Description of `NEMOGCM` directory tree 25 25 26 26 The image below shows the directory tree: … … 76 76 }}} 77 77 }}} 78 78 79 == 2. Extract and install XIOS 79 80 … … 86 87 * key_iomput 87 88 * key_mpp_mpi (if you want to use "detached mode") 88 * key_xios2 if you wish to use XIOS2 in nemo_v3_6_STABLE . XIOS2is the only version available in the trunk.89 * key_xios2 if you wish to use XIOS2 in nemo_v3_6_STABLE, it is the only version available in the trunk. 89 90 90 == 3. Setup your ARCHfile91 == 3. Setup your architecture configuration file 91 92 92 All compiler options in NEMO are controlled using files in NEMOGCM/ARCH/arch-[[span(my_arch, style=color: #BB4444 )]].fcm where [[span(my_arch, style=color: #BB4444 )]] is the name of your architecture FCM file.\\ 93 It is recommended to copy and rename an ARCH file from an architecture similar to your own architecture. You will need to set appropriate values for all of the variables in the file. The FCM variables `%NCDF_HOME`, `%HDF5_HOME` and `%XIOS_HOME` should be set to the installation directories used above. 94 [[IncludeSource(/branches/2015/nemo_v3_6_STABLE/NEMOGCM/ARCH/arch-macport_osx.fcm, start=42, end=45, mimetype=application/x-shellscript, line_numbers=0)]] 93 All compiler options in NEMO are controlled using files in `NEMOGCM/ARCH/arch-`[[span('my_arch', style=color: #BB4444 )]]`.fcm` where [[span('my_arch', style=color: #BB4444 )]] is the name of the computing architecture.\\ 94 It is recommended to copy and rename an configuration file from an architecture similar to your owns. You will need to set appropriate values for all of the variables in the file. In particular the FCM variables `%NCDF_HOME`, `%HDF5_HOME` and `%XIOS_HOME` should be set to the installation directories used for XIOS installation. 95 96 [[IncludeSource(/branches/2015/nemo_v3_6_STABLE/NEMOGCM/ARCH/arch-macport_osx.fcm, start=42, end=45, mimetype=application/x-shellscript, line_numbers=0)]] 97 95 98 == 4. Compile and create NEMO executable 96 99 97 The main script to compile and create executable is called `makenemo` and located in the `CONFIG` directory. To identify the source code you need, to build the makefile and run it.[[BR]] 98 As an example, compile GYRE with [[span(my_arch, style=color: #BB4444 )]] to create a [[span(MY_GYRE, style=color: #BB4444 )]] configuration: 100 The main script to compile and create executable is called `makenemo` and located in the `CONFIG` directory, it is used to identify the routines you need from the source code, to build the makefile and run it.[[BR]] 101 As an example, compile GYRE with [[span('my_arch', style=color: #BB4444 )]] to create a [[span('MY_GYRE', style=color: #BB4444 )]] configuration: 102 99 103 {{{#!sh 100 cd NEMOGCM/CONFIG; ./makenemo –m 'my_arch' –r GYRE -n 'MY_GYRE'104 cd NEMOGCM/CONFIG; ./makenemo –m 'my_arch' –r GYRE -n 'MY_GYRE' 101 105 }}} 102 106 103 After successful execution of `makenemo` command, the executable called `opa` is created in the EXP00 directory (in the example above, the executable is created in `CONFIG/MY_GYRE/EXP00`) 104 105 106 The image below shows the directory tree characterized by [[span("MY_CONFIG", style=color: #BB4444 )]] new 'branch'. All directories and fundamental files created by makenemo are highlighted in green. 107 In particular, even if not shown in the figure, `WORK` folder contains links to the compiled routines. 107 The image below shows the structure and some content of [[span("MY_CONFIG", style=color: #BB4444 )]] directory from the launching of the configuration creation ([[span(directories and fundamental files created by makenemo, style=color:green)]]). 108 108 109 109 {{{#!table style="border: none; margin: auto;" … … 117 117 }}} 118 118 {{{#!td 119 Symbolic links to all unpreprocessed routines considered in the configuration119 Folder with the symbolic links to all unpreprocessed routines considered in the configuration 120 120 }}} 121 121 |- … … 144 144 }}} 145 145 146 After successful execution of `makenemo` command, the executable called `opa` is created in the `EXP00` directory (in the example above, the executable is created in `CONFIG/MY_GYRE/EXP00`). 147 146 148 === More options 147 149 … … 150 152 === Default behaviour 151 153 152 At the first use, you need the `-m` option to specify compiler, its options and libraries, then for next compilation, it is assumed you will be using the same compiler.[[BR]]153 If `–n` option is not specified, `ORCA2_LIM` is the default configuration used. `-d` option has been implemented for use in non-interactive shell. The `WORK` directory is created under each configuration directory.154 * At the first use, you need the `-m` option to specify the architecture configuration file (compiler and its options, routines and libraries to include), then for next compilation, it is assumed you will be using the same compiler.[[BR]] 155 * If `–n` option is not specified, `ORCA2_LIM` is the default configuration used. 154 156 155 157 === Tools used during the process … … 162 164 163 165 [[IncludeSource(/branches/2015/nemo_v3_6_STABLE/NEMOGCM/CONFIG/makenemo, start=145, end=166, mimetype=application/x-shellscript, line_numbers=0)]] 166 164 167 == 5. Running the model 165 168 166 169 Once `makenemo` has run successfully, the `opa` executable is available in `CONFIG/"MY_CONFIG"/EXP00`[[BR]] 167 For the reference configurations, the `EXP00` directory also contains the small ASCII input file (namelists, *xml files for the IOs...). If the configuration also needs NetCDF input files, this should be downloaded into the `EXP00` directory from the corresponding tarfile, see [wiki:Users/ReferenceConfigurations]170 For the reference configurations, the `EXP00` folder also contains the initial input files (namelists, *xml files for the IOs...). If the configuration also needs NetCDF input files, this should be downloaded here from the corresponding tar file, see [wiki:Users/ReferenceConfigurations] 168 171 169 172 {{{#!sh 170 cd CONFIG/'MY_CONFIG'/EXP00171 mpirun -n $NPROCS ./opa # $NPROCS is the number of processes ; mpirun is your MPI wrapper173 cd 'MY_CONFIG'/EXP00 174 mpirun -n $NPROCS ./opa # $NPROCS is the number of processes ; mpirun is your MPI wrapper 172 175 }}} 173 176 … … 175 178 176 179 For a given configuration (here called [[span(MY_CONFIG, style=color: #BB4444 )]]), the list of active CPP keys can be found in 180 177 181 {{{#!sh 178 NEMOGCM/CONFIG/'MYCONFIG'/cpp_'MY_CONFIG'.fcm182 NEMOGCM/CONFIG/'MYCONFIG'/cpp_'MY_CONFIG'.fcm 179 183 }}} 180 184 181 This text file can be edited to change the list of active CPP keys. Once changed, one needs to recompile NEMOusing `makenemo` command in order for this change to be taken in account.185 This text file can be edited to change the list of active CPP keys. Once changed, one needs to recompile `opa` executable using `makenemo` command in order for this change to be taken in account.