Version 21 (modified by jgipsl, 5 years ago) (diff) |
---|
How to install and compile ORCHIDEE with modipsl and libIGCM for offline use
- If you want to know more about compiling ORCHIDEE, see Documentation/UserGuide/CompileMethods.
- After the compilation is done as described on this page, you can run the model using
- libIGCM, method advised for all developments and simulation when access to IPSL machines: Documentation/UserGuide/Config
- small test case, advised for learning to know the model and for developments: Documentation/UserGuide/TestCase1
- small test case in parallel, advised for testing developments: Documentation/UserGuide/TestCaseBatch
ORCHIDEE trunk version
To extract and compile the latest trunk version of ORCHIDEE and configuration files for offline simulations (note that for obelix you may need to load the openmpi library first with the command 'module load openmpi') :
svn co http://forge.ipsl.jussieu.fr/igcmg/svn/modipsl/trunk modipsl cd modipsl/util ./model ORCHIDEE_trunk cd ../config/ORCHIDEE_OL gmake
If you install on a local PC or a cluster not maintained by IPSL-CMC, then you need to add compile options for your system. See here how to proceed: https://forge.ipsl.jussieu.fr/igcmg_doc/wiki/DocBenv#HowtousetheIPSLmodelsandtoolswithalocalPC
Specific revision on the trunk
It is possible to define a specific revision on the trunk before extraction. The file util/mod.def describes the contents for all predefined configurations. For example the content in configuration ORCHIDEE_trunk are ORCHIDEE, XIOS, IOIPSL, libIGCM and configuration directory ORCHIDEE_OL. All these components have a specific revision number set in mod.def or HEAD which means the latest revision on the version.
Change in mod.def before extracting the model by ./model ORCHIDEE_trunk to have the revision XXX on trunk ORCHIDEE:
#-C- ORCHIDEE_trunk trunk/ORCHIDEE HEAD 14 ORCHIDEE modeles #-C- ORCHIDEE_trunk trunk/ORCHIDEE_OL HEAD 14 ORCHIDEE_OL config
into
#-C- ORCHIDEE_trunk trunk/ORCHIDEE XXX 14 ORCHIDEE modeles #-C- ORCHIDEE_trunk trunk/ORCHIDEE_OL HEAD 14 ORCHIDEE_OL config
Note that for most cases you do not need to change ORCHIDEE_OL revision. This directory contains the configurations files to run with libIGCM. Sometimes there are incoherences between older revisions of ORCHIDEE and the latest version of the configuration but in most cases it is recommended to take the latest version of the configuration.
It is also possible to change the revision of ORCHIDEE after the configuration has been extracted. In that case, go to modeles/ORCHIDEE directory and update using svn:
cd modipsl/modeles/ORCHIDEE svn info # To know which version you extracted svn stat # To know if you have any local modifications svn update -r XXX
ORCHIDEE tagged versions
The tagged versions of ORCHIDEE have a corresponging offline configuration which can be extracted using "./model target" and compiled in the same way as described for the trunk above. The target has the same name as the name of the tag. Currently there are 3 tagged versions available in modipsl by default: ORCHIDEE_2_1 (most recent tag), ORCHIDEE_2_0 (tag used for CMIP6) and ORCHIDEE_AR5 (tag used for CMIP5). To extract and compile do as follow:
svn co http://forge.ipsl.jussieu.fr/igcmg/svn/modipsl/trunk modipsl cd modipsl/util ./model ORCHIDEE_2_0 # or another tag cd ../config/ORCHIDEE_OL gmake
Branch or other version on svn
Do as for the trunk but modify the file mod.def to extract a specific version of ORCHIDEE before launching the command ./model ORCHIDEE_trunk. The file mod.def specifies all components to be extracted with the script model for each configuration predefined.
Do first:
svn co http://forge.ipsl.jussieu.fr/igcmg/svn/modipsl/trunk modipsl cd modipsl/util
Edit now the file mod.def for the line corresponding to extraction of ORCHIDEE sources for target ORCHIDEE_trunk.
Following line needs to be changed :
#-C- ORCHIDEE_trunk trunk/ORCHIDEE HEAD 14 ORCHIDEE modeles
Replace trunk/ORCHIDEE by the path to your branch or personal directory. HEAD can also be changed to a specific revision number. For example for the branch ORCHIDEE-MICT, following should be set:
#-C- ORCHIDEE_trunk branches/ORCHIDEE-MICT/ORCHIDEE HEAD 14 ORCHIDEE modeles
You can also change the config/ORCHIDEE_OL folder if your branch has a specific one. For this, change also trunk/ORCHIDEE_OL on the following line in mod.def:
#-C- ORCHIDEE_trunk trunk/ORCHIDEE_OL HEAD 14 ORCHIDEE_OL config
Now continue with the extraction of the model:
./model ORCHIDEE_trunk cd ../config/ORCHIDEE_OL gmake
Optional method for a branch or other version on svn
You can also install the trunk and afterwards remove ORCHIDEE and change it to another version from svn or a local version. In this case you will keep the configuration files from the trunk version :
svn co http://forge.ipsl.jussieu.fr/igcmg/svn/modipsl/trunk modipsl cd modipsl/util ./model ORCHIDEE_trunk cd ../modeles rm -fr ORCHIDEE svn co svn://forge.ipsl.jussieu.fr/orchidee/branches/xxxxxxx/ORCHIDEE ORCHIDEE # or a copy from a local version of ORCHIDEE cd ../util ; ./ins_make # Create makefiles cd ../modeles/ORCHIDEE gmake driver
NB! For old branches with fortran code in ORCHIDEE_OL directory
For exemple orchidee_FM
In the trunk and in the newer branches, the directory ORCHIDEE/src_driver contain the source code for the driver. In older versions, these files were stored in ORCHIDEE_OL directory. Therefor for these older branches, you have to extract ORCHIDEE and ORCHIDEE_OL from the branch. For running with libIGCM, we recomand to use the trunk version of the scripts in ORCHIDEE_OL. Extract the trunk/ORCHIDEE_OL and save it in ORCHIDEE_OL.trunk. In mod.def, the lines corresponding to extraction of ORCHIDEE becomes the following :
#-C- ORCHIDEE_trunk branches/MYOLDBRANCHE/ORCHIDEE HEAD 14 ORCHIDEE modeles #-C- ORCHIDEE_trunk branches/MYOLDBRANCHE/ORCHIDEE_OL HEAD 14 ORCHIDEE_OL modeles #-C- ORCHIDEE_trunk trunk/ORCHIDEE_OL HEAD 14 ORCHIDEE_OL.trunk config
Note that the compiling is different:
cd modipsl/modeles/ORCHIDEE_OL gmake orchidee_ol gmake teststomate gmake forcesoil