Changes between Version 21 and Version 22 of Documentation/UserGuide/InstallingORCHIDEEBasic
- Timestamp:
- 2020-02-26T15:56:01+01:00 (4 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Documentation/UserGuide/InstallingORCHIDEEBasic
v21 v22 1 1 = How to install and compile ORCHIDEE with modipsl and libIGCM for offline use = 2 Author: J. Ghattas[[BR]] 3 Last revision: 2020/02/26, J. Ghattas 4 2 5 [[PageOutline]] 6 3 7 * If you want to know more about compiling ORCHIDEE, see [wiki:Documentation/UserGuide/CompileMethods]. 4 8 * After the compilation is done as described on this page, you can run the model using … … 8 12 9 13 == ORCHIDEE trunk version == 10 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'):14 To extract and compile the latest trunk version of ORCHIDEE and configuration files for offline simulations: 11 15 {{{ 12 16 svn co http://forge.ipsl.jussieu.fr/igcmg/svn/modipsl/trunk modipsl … … 14 18 ./model ORCHIDEE_trunk 15 19 cd ../config/ORCHIDEE_OL 16 gmake 20 ./compile_orchidee_ol.sh 17 21 }}} 22 23 If you want to compile with debug options, use following: 24 {{{ 25 ./compile_orchidee_ol.sh -debug 26 }}} 27 28 29 The model compile be default at the machines that we maintain at IPSL: irene/TGCC, jeanzay/IDRIS, obelix/LSCE and ciclad/climserv/IPSL. The compilation script loads all modules needed for compilation. 18 30 19 31 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 20 32 21 === Specific revision on the trunk === 22 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. [[BR]] 33 '''ORCHIDEE trunk version older than revision 6572'''[[BR]] 23 34 24 Change in mod.def before extracting the model by ./model ORCHIDEE_trunk to have the revision XXX on trunk ORCHIDEE:35 For older version of the trunk, the compilation script does not exist. For these versions there is a Makefile instead. The compilation is done in the same folder as above using following (note that your environment is important and modules need to be loaded before compilation, see [https://forge.ipsl.jussieu.fr/igcmg_doc/wiki/Doc/ComputingCenters igcmg_doc]: 25 36 {{{ 26 #-C- ORCHIDEE_trunk trunk/ORCHIDEE HEAD 14 ORCHIDEE modeles 27 #-C- ORCHIDEE_trunk trunk/ORCHIDEE_OL HEAD 14 ORCHIDEE_OL config 37 modipsl/config/ORCHIDEE_OL 38 gmake 28 39 }}} 29 into 30 {{{ 31 #-C- ORCHIDEE_trunk trunk/ORCHIDEE XXX 14 ORCHIDEE modeles 32 #-C- ORCHIDEE_trunk trunk/ORCHIDEE_OL HEAD 14 ORCHIDEE_OL config 33 }}} 34 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. 35 36 37 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: 38 39 {{{ 40 cd modipsl/modeles/ORCHIDEE 41 svn info # To know which version you extracted 42 svn stat # To know if you have any local modifications 43 svn update -r XXX 44 }}} 45 40 If you want to compile with debug options, you need to change this inside the Makefile. 46 41 47 42 == ORCHIDEE tagged versions == 48 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). 43 The tagged versions of ORCHIDEE have a corresponding 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_2_2 (actually a branch which some added developments). The version ORCHIDEE_AR5 also exists but is only available to extract source code without running and compiling possibility. 44 49 45 To extract and compile do as follow: 50 46 {{{ 51 47 svn co http://forge.ipsl.jussieu.fr/igcmg/svn/modipsl/trunk modipsl 52 48 cd modipsl/util 53 ./model ORCHIDEE_2_0 # or another tag49 ./model ORCHIDEE_2_0 # or ORCHIDEE_2_1 / ORCHIDEE_2_2 54 50 cd ../config/ORCHIDEE_OL 55 51 gmake … … 58 54 59 55 == Branch or other version on svn == 60 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. [[BR]]56 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 predefined configuration. [[BR]] 61 57 62 58 Do first: … … 67 63 68 64 Edit now the file mod.def for the line corresponding to extraction of ORCHIDEE sources for target ORCHIDEE_trunk.[[BR]] 69 Following line needs to be changed :65 Following lines needs to be changed : 70 66 71 67 {{{ 72 68 #-C- ORCHIDEE_trunk trunk/ORCHIDEE HEAD 14 ORCHIDEE modeles 69 #-C- ORCHIDEE_trunk trunk/ORCHIDEE_OL HEAD 14 ORCHIDEE_OL config 73 70 }}} 74 71 75 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: 72 If you want a specific revision on the trunk, then change HEAD in above lines to the revision you want. Note that you can often keep the HEAD revision of the ORCHIDEE_OL folder together with a specific revision of the sources ORCHIDEE. 76 73 74 If you want to change to a branch or a personal version, then 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-CN-CAN, following should be set: 77 75 {{{ 78 #-C- ORCHIDEE_trunk branches/ORCHIDEE-MICT/ORCHIDEE HEAD 14 ORCHIDEE modeles 76 #-C- ORCHIDEE_trunk branches/ORCHIDEE-CN-CAN/ORCHIDEE HEAD 14 ORCHIDEE modeles 77 #-C- ORCHIDEE_trunk branches/ORCHIDEE-CN-CAN/ORCHIDEE_OL HEAD 14 ORCHIDEE_OL config 79 78 }}} 80 79 81 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: 82 {{{ 83 #-C- ORCHIDEE_trunk trunk/ORCHIDEE_OL HEAD 14 ORCHIDEE_OL config 84 }}} 85 86 80 If you version do not have a ORCHIDEE_OL folder, then keep the trunk version. 87 81 88 82 Now continue with the extraction of the model: … … 90 84 ./model ORCHIDEE_trunk 91 85 cd ../config/ORCHIDEE_OL 92 gmake93 86 }}} 94 87 88 Compile using gmake (if the Makefile exist in your version) or ./compile_orchidee_ol.sh depending on the version. 95 89 96 == Optional method for a branch or other version on svn ==97 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 :98 {{{99 svn co http://forge.ipsl.jussieu.fr/igcmg/svn/modipsl/trunk modipsl100 cd modipsl/util101 ./model ORCHIDEE_trunk102 cd ../modeles103 rm -fr ORCHIDEE104 svn co svn://forge.ipsl.jussieu.fr/orchidee/branches/xxxxxxx/ORCHIDEE ORCHIDEE # or a copy from a local version of ORCHIDEE105 cd ../util ; ./ins_make # Create makefiles106 cd ../modeles/ORCHIDEE107 gmake driver108 }}}109 90 110 91 == NB! For old branches with fortran code in ORCHIDEE_OL directory ==