{{{
#!html
Compile
}}}
----
[[NoteBox(note,The compiling steps are described in this chapter., 600px)]]
[[PageOutline(1-2,Table of contents,pullout)]]
----
# Compiling environment #
[[NoteBox(warn,First of all\, make sure that your working environment contains all the necessary compiling tools. To this end\, see the chapter [wiki:Doc/ComputingCenters Computing environments], 600px)]]
## FCM ##
Most of IPSL models and components use the '''fcm''' tool for compiling. Recent versions of the models have fcm in their source directory. Therefore no specific installation is needed anymore.
If no fcm is available in the source directory, fcm must then be installed and added to your environment variable PATH. At following machines, fcm is already installed
{{{
# At TGCC:
PATH=`ccc_home -u igcmg`/Tools/fcm/bin:$PATH
# At IDRIS:
PATH=
# At LSCE(obelix):
PATH=/home/orchideeshare/igcmg/fcm/FCM_V1.2/bin:$PATH
}}}
For other machines, extract fcm from svn and add the path to your environment variable PATH. Extract as follow:
{{{
svn co http://forge.ipsl.fr/fcm/svn/PATCHED/FCM_V1.2 fcm
}}}
For each machine supported by the IPSL tools, 3 kinds of files '''*.fcm''', '''*.path''', and '''.env''' exist. They provide all the information specific to a machine needed by fcm to create a makefile. These files are stored in the directory arch/ (LMDZ/arch/, INCA/arch/).
* *.fcm : contains the compiler information
* compiler name
* compiling options
* options and settings
* *.path : contains the library path names.
* *.env : contains module to be load to install properly the environment for the compilation of this model.
These files have the name of the machine as a prefix : arch-X64_IRENE.fcm, arch-X64_IRENE.path
'''Note''' : for configurations IPSLCM, arch files for OASIS and NEMO are taken in `modipsl/config/IPSLCM*/SOURCE/OASIS` and `modipsl/config/IPSLCM6/SOURCE/NEMO`
# Makefile for configurations _v6 and _v6.1.* #
## Creating the main makefile ##
Each model configuration XXX has a main makefile which provides information about each model component's makefiles. The main Makefile is stored in the modipsl/config/XXXX directory. The main Makefile is created when a model configuration is downloaded and installed. [[BR]]
Example :
{{{
#!sh
cd modipsl/util
./model LMDZOR_v6.1.10
(...)
Makefiles setup, scripts and data for irene
Installation in ../config/LMDZOR_v6
Path from Makefile to modipsl/util : ../../util
}}}
You can recreate those Makefiles by running the '''`ins_make`''' script. You have to do this if, for example, you changed the path of modipsl.
{{{
#!sh
cd modipsl/util/
./ins_make
}}}
The main Makefile is created by concatenating the following 3 items: ''AA_make.ldef'' and ''AA_make'' located in the directory where the main Makefile will be created, and the lines corresponding explicitly to the target machine of the ''util/AA_make.gdef'' file. For each predefined machine the util/AA_make.gdef file contains the compiler settings. If your machine is not included, you can choose a target among the predefined machines in AA_make.gdef or you can add a new one.
{{{
#!sh
vi AA_make.gdef
(...)
#-Q- jeanzay
(...)
#-Q- irene
(...)
#-Q- aix6
(...)
#-Q- gfortran
(...)
}}}
In this case, the script becomes
{{{
#!sh
./ins_make -t target
}}}
## The main makefile ##
The Makefile is available for different resolutions. Example with LMDZOR_v6.1.10 :
{{{
LMD5655 : libioipsl xios liborchidee lmdz56x55x19 verif
echo "noORCAxLMD5655" >.resol
echo "RESOL_ATM_3D=56x55x19" >>.resol
LMD9671 : libioipsl xios liborchidee lmdz96x71x19 verif
echo "noORCAxLMD9671" >.resol
echo "RESOL_ATM_3D=96x71x19" >>.resol
LMD9695 : libioipsl xios liborchidee lmdz96x95x19 verif
echo "noORCAxLMD9695" >.resol
echo "RESOL_ATM_3D=96x95x19" >>.resol
LMD9695-L39 : libioipsl xios liborchidee lmdz96x95x39 verif
echo "noORCAxLMD9695-L39" >.resol
echo "RESOL_ATM_3D=96x95x39" >>.resol
LMD9695-L79 : libioipsl xios liborchidee lmdz96x95x79 verif
echo "noORCAxLMD9695-L79" >.resol
echo "RESOL_ATM_3D=96x95x79" >>.resol
LMD128118-L39 : libioipsl xios liborchidee lmdz128x118x39 verif
echo "noORCAxLMD128118-L39" >.resol
echo "RESOL_ATM_3D=128x118x39" >>.resol
LMD144142 : libioipsl xios liborchidee lmdz144x142x19 verif
echo "noORCAxLMD144142" >.resol
echo "RESOL_ATM_3D=144x142x19" >>.resol
LMD144142-L39 : libioipsl xios liborchidee lmdz144x142x39 verif
echo "noORCAxLMD144142-L39" >.resol
echo "RESOL_ATM_3D=144x142x39" >>.resol
LMD144142-L59 : libioipsl xios liborchidee lmdz144x142x59 verif
echo "noORCAxLMD144142-L59" >.resol
echo "RESOL_ATM_3D=144x142x59" >>.resol
LMD144142-L79 : libioipsl xios liborchidee lmdz144x142x79 verif
echo "noORCAxLMD144142-L79" >.resol
echo "RESOL_ATM_3D=144x142x79" >>.resol
LMD512360-L79 : libioipsl xios liborchidee lmdz512x360x79 verif
echo "noORCAxLMD512360-L79" >.resol
echo "RESOL_ATM_3D=512x360x79" >>.resol
}}}
Available resolutions are :
* LMD5655
* LMD9671
* LMD9695
* LMD9695-L39
* LMD9695-L79
* LMD128118-L39
* LMD144142
* LMD144142-L39
* LMD144142-L59
* LMD144142-L79
* LMD512360-L79
## How to compile? ##
Once you chose a resolution you can start compiling:
{{{
#!sh
gmake my_resolution
}}}
Example for LMDZOR_v6.1.10:
{{{
#!sh
cd modipsl/config/LMDZOR_v6
gmake LMD144142-L79
}}}
An hidden file '''.resol''' is created when compiling was successful. This file contains information about the resolution you have just compiled. This file will be used later when setting up the simulation, in particular to locate the input files.
[[BR]]Going back to the previous example, the .resol file looks as follows :
{{{
noORCAxLMD144142-L79
RESOL_ATM_3D=144x142x79
}}}
[[NoteBox(note,Once the file `.resol` is created\, you can recompile your configuration using the gmake script without specifying the resolution., 600px)]]
For ORCHIDEE_OL, the resolution is not specified during run time. Use only '''gmake'''to compile. The file `.resol` will not be created.
## How to change compile options for debugging or optimization of the model? ##
* You can change your optimization options for IOIPSL models in the AA_make.gdef file. To this end you must find your target machine and change the associated lines. You will have to recreate the Makefile.
* Three levels of optimization for the ORCHIDEE, INCA and LMDZ models are predefined in the `arch/files`.You need to write them in the modipsl/config/.../Makefile file. The three options are: '''-debug''', '''-dev''', '''-prod'''. XIOS offers the same three levels of compilations, accessible through the flags `--debug`, `--dev` and `prod`.
[[BR]]
Example: to compile LMDZ you can add the keyword "-debug" :
{{{
(cd ../../modeles/LMDZ; ./makelmdz_fcm (...) -debug (...) -arch $(FCM_ARCH) gcm ; cp bin/gcm_$(RESOL_LMDZ)_phylmd_para_orch.e ../../bin/gcm.e ; )
}}}
[[NoteBox(note, The default option is `-prod`, 600px)]]
# 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'''
* LMDZOR_v6.2 and LMDZOR_v6.3 : '''compile_lmdzor.sh'''
* LMDZORINCA_v6.2 : '''compile_lmdzorinca.sh'''
* ICOLMDZOR_v7 : '''compile_icolmdzor.sh'''
* ORCHIDEE_OL using the trunk ORCHIDEE from revision 6526 and ORCHIDEE_3 : '''compile_orchidee_ol.sh'''
For each script you can use the option "-h" to know the usage of the script. You can find a description of each script on its configuration page (for example [wiki:Doc/Config/IPSLCM6.2 IPSLCM6.2])
See here some examples for compilation:
{{{
cd modipsl/config/ConfigName
Default compilation, default resolution and in production mode will be set:
./compile_ConfigName.sh
Compilation in debug mode, default resolution:
./compile_ConfigName.sh -debug
Complete recompilation:
./compile_ConfigName.sh -full
}}}
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 modipsl/config/IPSLCM6
ARCH/
compile_ipslcm6.sh
EXPERIMENTS/
GENERAL/
SOURCES/
> ls modipsl/config/IPSLCM6/ARCH/
arch-X64_IRENE.env
arch-X64_JEANZAY.env
}}}
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.
{{{
> ls modipsl/bin
gcm_144x142x79_prod.e
xios_server_prod.exe
opa_ORCA1_prod
}}}
## 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
}}}
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)]]
# Compilation options for configurations _v7 and newer #
## sub-configuration ##
As with v6.2 configurations, compilation of v7 configurations is managed via a [wiki:Doc/Compile#Scriptforconfigurations_v6.2andnewer compilation script]. However, a new option has been added to handle the different sub-configurations of the coupled model. (Read [wiki:Doc/Install#v7family install v7 family documentation] for more information on this new specificity).
You can now choose to compile the entire extracted configuration or just a sub-configuration. To do this, use the `-subconfig` option.
{{{
./compile_ipslcm7.sh -h
(...)
[-subconfig X] Set this option if you want to compile a sub-configuration. X can be one of following sub-configurations :
ICOLMDZORINCA, ICOLMDZOR, LMDZORINCA, LMDZOR, IPSLCM-reg or IPSLCM
By default, all available components are compiled.
(...)
}}}
For example to compile only LMDZOR if you have extracted full IPSLCM7, IPSLCM7-ico, or ICOLMDZOR :
{{{
./compile_ipslcm7.sh -subconfig LMDZOR -regular_latlon yes
}}}
If you to compile only ICOLMDZOR if you have extracted full IPSLCM7, IPSLCM7-ico, or ICOLMDZOR
{{{
./compile_ipslcm7.sh -subconfig ICOLMDZOR -regular_latlon no
}}}
## choose Orchidee version ##
The v7 family lets you switch between ORCHIDEE_2_2 and ORCHIDEE_4 ('''= ORCHIDEE_trunk on 2023 december'''). This choice can be made at compile time with the `-orch4` or `-orch22` options (by default `-orch22`is activated).
{{{
./compile_ipslcm7.sh -h
(...)
[-orch4 / -orch22] Choice of ORCHIDEE version. The source code are found in modeles/ORCHIDEE_trunk or modeles/ORCHIDEE_2_2
and a link will be set to the choosen model version. Default version is currently ORCHIDEE_2_2 (-orch22).
(...)
}}}
## Orchidee Offline ##
Orchidee offline is compiled by default. To use these executables you need in `modipsl/config/ORCHIDEE_OL_2_2`(or in `modipsl/config/ORCHIDEE_OL_4`) to create a arch.env file :
{{{
cd modipsl/config/ORCHIDEE_OL_*
cd ARCH/
ln -s arch-****.env arch.env
## for JeanZay : ln -s arch-X64_JEANZAY.env arch.env
}}}