Changes between Version 34 and Version 35 of Doc/Compile

Timestamp:

02/25/20 10:15:27 (4 years ago)

Author:

jgipsl

Comment:

--

Doc/Compile

@@ -47 +47 @@
 '''Note''' : for configurations IPSLCM, arch files for OASIS and NEMO are taken in `modipsl/config/IPSLCM*/SOURCE/OASIS` and  `modipsl/config/IPSLCM6/SOURCE/NEMO`
 
-# Compilation using Makefile for configurations _v6 and _v6.1.* #
+# Makefile for configurations _v6 and _v6.1.* #
 ## Creating the main makefile ##
 
@@ -198 +198 @@
  
 
-# Compilation using script for configurations _v6.2 and newer configurations #
-
+# Script for configurations _v6.2 and newer #
+
+## Compile using a main script ##
 The compilation differs from what has been done so far. Now we use a script  '''compile_ConfigName.sh''' with several options ( resolution, level of optimization, full or partial recompilation ) to compile the model.
   * IPSLCM6.2 : '''compile_ipslcm6.sh'''
@@ -224 +225 @@
 
 
-
-The configuration is not longer depending on the users environement, there is no need to ensure loading the correct modules before compilation. Instead, in the beginning of the compilation script, the environment will be loaded using a specific architecture depending file in `ARCH` directory.  
-{{{
-> ls IPSLCM6.2
+For machines where the configuration has been adapted, the configuration is not longer depending on the users environment, there is no need to ensure loading the correct modules before compilation. Instead, in the beginning of the compilation script, the environment will be loaded using a specific architecture dependent file in `ARCH` directory.  
+{{{
+> ls config/IPSLCM6
   ARCH/  compile_ipslcm6.sh*  EXPERIMENTS/  GENERAL/  README  SOURCES/
-> ls IPSLCM6.2/ARCH/
+> ls config/IPSLCM6/ARCH/
   arch-X64_IRENE.env arch-X64_JEANZAY.env
 }}}
-The script set a link to '''arch.env''' if '''arch-${FCM_ARCH}.env''' file exists for current FCM_ARCH. This link '''arch.env''' is also set in config.card and will be used by libIGCM to ensure the same running environment.
+The compilation script finds out which is the file to be used from ARCH folder and sets a link from '''arch-${FCM_ARCH}.env''' to '''arch.env'''. This is done only on machines where the configuration has been adapted. 
+
+For a local machine, it is possible to add a file ARCH/arch-myarch.env and compile with argument:
+{{{
+./compile_ConfigName.sh -arch myarch
+}}}
+
+
+At the end of the compilation the binaries will be store with a specific name : binary_${!ResolAtm}_${!OptMode}, where `ResolAtm` is the resolution of LMDZ model, and `OptMode` the level of optimization (prod, debug, dev) use during the compilation. 
+
+## Link to the execution ##
+It is important to use the same modules during compilation and run time. The file '''arch.env''' linked by the compilation script is also set in config.card and will be used by libIGCM to ensure the same running environment. In the beginning of config.card, following is set:
 {{{
 #-- Source following file with module settings, only if it exists
 EnvFile=${SUBMIT_DIR}/../ARCH/arch.env
 }}}
-
-
-At the end of the compilation the binary will be store with a specific name : binary_${resol_atm}_${optmode}, where `resol_atm` is the resolution of LMDZ model, and `optmode` the level of optimization (prod, debug, dev) use during the compilation. 
+If there is no ARCH/arch.env file, libIGCM will source a default file which corresponds to the one used for v6.1 configurations. 
+
+Further down in config.card, following variables used to copy the right executables are specified, here for the IPSLCM6 configuration:
+{{{
+#-- ResolAtm and ResolOce indicates the atmospheric and ocean resolution
+#   These variables are used in the executable name 
+ResolAtm=144x142x79
+ResolOce=ORCA1
+#============================
+# OptMode indicates the optimization mode chosen during compilation
+# This variable is used in the executable name
+OptMode=prod
+}}}
+They are used to copy the executables. If you compile in default mode, no changes are needed. But if you change the resolution or the optimization mode, change these variables accordingly. 
+
 [[NoteBox(warn, If you compile in debug or in dev mode you need to modify the parameter !OptMode in config.card before submitting the job. If you change the resolution at the compilation you need to modify the parameter !ResolAtm in config.card, 600px)]]