How to install ORCHIDEE in coupled mode with LMDZ

Author: J. Ghattas
Last revision: 2024/06/07, J. Ghattas

There are different predefined configurations in modipsl containing LMDZ and ORCHIDEE. Different configurations are adapted to different versions of the modeles.

• IPSLCM7_work : Working configuration for the next coupled model under development. It contains both ORCHIDEE_2_2 and ORCHIDEE trunk, the choice is done when compiling. It is possible to extract a sub-configuration such as LMDZOR or ICOLMDZOR.

• LMDZOR_v6.4_beta : Frozen working configuration which uses a fixed revision of ORCHIDEE/trunk. The version of LMDZ is the same as in LMDZOR_v6.2.4, and compilation is the same as for LMDZOR_v6.2.4. Only ORCHIDEE version differs between the two.
  

• LMDZOR_v6.3_work : Working configuration which uses the latest revision of ORCHIDEE_3 branch (version copied from the trunk including nitrogen cycle). The version of LMDZ is the same as in LMDZOR_v6.2.4, and compilation is the same as for LMDZOR_v6.2.4. Only ORCHIDEE version differs between the two .
  

• LMDZOR_v6.2.4 : Frozen configuration which uses ORCHIDEE_2_2 and LMDZ6/trunk, same revisions as in IPSLCM6.2.4.
  

• LMDZOR_v6.1.X : Configurations used for CMIP6 production simulations using stable versions of LMDZ and tag ORCHDIEE_2_0, ​read more about LMDZOR_v6. Take the highest number of X (currently LMDZOR_v6.1.10).
  

Usage of these configurations are covered by the igcmg_doc documentation : ​https://forge.ipsl.jussieu.fr/igcmg_doc/wiki/Doc

Quick installation of sub-configuration LMDZ-ORCHIDEE within IPSLCM7_work

For all configuration in the generation v7, IPSLCM7, only one fully coupled configuration exist. Using this configuration, it is possible to install a sub-configuration with only the parts you want. For example a sub-configuration is ICOLMDZOR containing DYNAMICO, LMDZ and ORCHIDEE. This sub-configuration can be used on the icosahedric grid or on the regular lat-lon grid. Another sub-configuration is LMDZOR which can only be used on the regular lat-lon grid.

With this configuration, both ORCHIDEE_2_2 and ORCHIDEE trunk (called ORCHIDEE_4) are downloaded but only one is compiled. Currently by default it is ORCHIDEE_2_2 which is compiled. You can add -orch4 to compile ORCHIDEE trunk instead. A suffix v22(for ORCHIDEE_2_2) or v4(for ORCHIDEE trunk) is added to the name of the executable, see folder modipsl/bin.

svn co http://forge.ipsl.jussieu.fr/igcmg/svn/modipsl/trunk modipsl
cd modipsl/util
./model IPSLCM7_work LMDZOR
cd ../config/IPSLCM7

To compile ORCHIDEE_4(trunk) add argument -orch4:

./compile_ipslcm7.sh -orch4

To compile ORCHIDEE_2_2, this is the default:

./compile_ipslcm7.sh

It is possible to compile both ORCHIDEE_4 and ORCHIDEE_2_2 within the same modipsl. When you choose an experiment set up, use the once with suffex .orch4 for ORCHIDEE_4 or the one without suffix for ORCHIDEE_2_2.

Quick installation of sub-configuration DYNAMICO-LMDZ-ORCHIDEE within IPSLCM7_work

Same as LMDZOR but extract subconfiguration ICOLMDZOR.

See here how to install the sub-configuration ICOLMDZOR:

svn co http://forge.ipsl.jussieu.fr/igcmg/svn/modipsl/trunk modipsl
cd modipsl/util
./model IPSLCM7_work ICOLMDZOR
cd ../config/IPSLCM7

# with ORCHIDEE_4
./compile_ipslcm7.sh -orch4

# or with ORCHIDEE_2_2
./compile_ipslcm7.sh 

Quick installation of LMDZOR_v6.4_beta

Use the same method for LMDZOR_v6.3_work or LMDZOR_v6.2_beta.

svn co http://forge.ipsl.jussieu.fr/igcmg/svn/modipsl/trunk modipsl
cd modipsl/util
./model LMDZOR_v6.4_beta
cd ../config/LMDZOR_v6
./compile_lmdzor.sh

Compilation is done for a default horizontal grid and using compile option for production mode. The default settings can be changed optional arguments. Access to the help using ./compile_lmdzor.sh -h.

Quick installation of LMDZOR_v6.1.10

This configuration and older once are compiled using Makefile. More recent configurations uses a compilation script instead.

svn co http://forge.ipsl.jussieu.fr/igcmg/svn/modipsl/trunk modipsl
cd modipsl/util
./model LMDZOR_v6.1.10
cd ../config/LMDZOR_v6
gmake

Install a branch ORCHIDEE with LMDZ

If you want to extract a branch of ORCHIDEE instead of the trunk, first you need to know if the branch is updated or created after the nitrogen cycle was introduced in the trunk, ORCHIDEE/trunk revision 5639. If the branch was developed upon the ORCHIDEE/trunk revision 5639 or later version, then use the configuration LMDZOR_v6.3_work. Otherwise use one of the LMDZOR_v6.1.X configurations. See here an example for extracting and compiling of ORCHIDEE-MICT with the default LMDZ6 version. In the example below you can change ORCHIDEE-MICT into another branch name when you use a different one. .

svn co http://forge.ipsl.jussieu.fr/igcmg/svn/modipsl/trunk modipsl
cd modipsl/util
vi mod.def   

    Modifiy the line: 
#-C- LMDZOR_v6.1.10  tags/ORCHIDEE_2_0/ORCHIDEE         6268    14   ORCHIDEE     modeles
    
    Into the line:
#-C- LMDZOR_v6.1.10  branches/ORCHIDEE-MICT/ORCHIDEE    HEAD    14   ORCHIDEE     modeles


./model LMDZOR_v6.1.10
cd ../config/LMDZOR_v6
gmake

LMDZ at obelix

LMDZ can be used at LSCE/obelix cluster. See here some hints for running LMDZ at obelix ​https://forge.ipsl.jussieu.fr/igcmg_doc/wiki/Doc/ComputingCenters/LSCE.