= How to install ORCHIDEE in coupled mode with LMDZ =

Author: J. Ghattas[[BR]]
Last revision: 2020/03/19, J. Ghattas

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

See also the list of configurations in http://forge.ipsl.jussieu.fr/igcmg_doc/wiki/Doc/Config#LMDZOR

 * '''LMDZOR_v6.4_work'''         : Working configuration which uses the latest revision of ORCHIDEE/trunk. The version of LMDZ is the same as in LMDZOR_v6.2, and compilation is the same as for LMDZOR_v6.2_work. Only ORCHIDEE version differs between the two.[[BR]]

 * '''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, and compilation is the same as for LMDZOR_v6.2_work. Only ORCHIDEE version differs between the two .[[BR]]

 * '''LMDZOR_v6.2_work'''         : Working configuration which uses ORCHIDEE_2_2 and LMDZ6/trunk. [[BR]]

 * '''LMDZOR_v6.1.X'''            : Configurations used for CMIP6 production simulations using stable versions of LMDZ and tag ORCHDIEE_2_0, [http://forge.ipsl.jussieu.fr/igcmg_doc/wiki/Doc/Config/LMDZOR_v6.1 read more about LMDZOR_v6]. Take the highest number of X (currently LMDZOR_v6.1.10).[[BR]]


 * ''(Obsolete LMDZOR_v5    : Contains a trunk version 2076 of LMDZ5 and ORCHIDEE tagged version 1.9.5 (CMIP5 version))''[[BR]]

 * ''(Obsolete LMDZOR_v5.2  : Contains the same LMDZ5 as LMDZOR_v5 and revision 2247 on the trunk of ORCHIDEE)''

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


== Quick summary for installing LMDZOR_v6.4_work ==
Use the same method for LMDZOR_v6.3_work or LMDZOR_v6.2_work.
{{{
svn co http://forge.ipsl.jussieu.fr/igcmg/svn/modipsl/trunk modipsl
cd modipsl/util
./model LMDZOR_v6.4_work
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 summary for installing 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].