Changes between Version 26 and Version 27 of Documentation/UserGuide/InstallingORCHIDEE


Ignore:
Timestamp:
2020-02-28T11:49:00+01:00 (4 years ago)
Author:
mmcgrath
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/UserGuide/InstallingORCHIDEE

    v26 v27  
    33 
    44Author: D: Solyga 
    5 Last revision: 2020/02/28, M. McGrath 
     5 
     6Last revision: 2020/02/28, M. !McGrath 
    67 
    78* It's best to install XIOS (the routines which manage input and output of the whole IPSL suite of models) first on your computer, and then compile ORCHIDEE with the same options.  Advice on installing XIOS on a personal computer is found here: https://forge.ipsl.jussieu.fr/igcmg_doc/wiki/Doc/ComputingCenters/LocalPC 
     
    4950 
    5051Download netcdf-c : 
    51 Open a terminal and type the following command (> represents the command prompt and should not be typed) to download netcdf version X.Y.Z (as of the time of writing, 4.7.3 is the most recent) :  
    52 {{{ 
    53     >   wget https://www.unidata.ucar.edu/downloads/netcdf/ftp/netcdf-c-X.Y.Z.tar.gz 
    54 }}} 
     52Open a terminal and type the following command (> represents the command prompt and should not be typed) to download the latest NetCDF version (as of the time of writing, 4.7.3 is the most recent) :  
     53{{{ 
     54    >   wget https://www.unidata.ucar.edu/downloads/netcdf/ftp/netcdf-c-4.7.3.tar.gz 
     55}}} 
     56Older versions can be download with: 
     57{{{ 
     58    >   wget https://github.com/Unidata/netcdf-c/archive/X.Y.Z.tar.gz 
     59}}} 
     60(where X, Y, and Z are 4.6.1, for example, or 4.7.0). 
     61 
    5562Extract the archive : 
    5663{{{ 
     
    147154      > make check 
    148155}}} 
    149 ( test the compilation ) 
     156( tests the compilation ) 
     157 
    150158and finally the installation : 
    151159 
     
    183191}}} 
    184192 
    185 After, you can delete the directory netcdf-c-X.Y.Z (still in root) : 
     193Afterwards, you can delete the directory netcdf-c-X.Y.Z if you want to (this is optional). 
    186194 
    187195{{{ 
     
    192200Remarks about installation: 
    193201 
    194 - Above mentioned packages should be installed. These packages should be installed with same compiler to keep consistency and avoid problems later on. In the case of more than one package installation, make sure to keep consistency between packages and libraries used to install ORCHIDEE (example: XIOS and ORCHIDEE should be installed with same netcdf library, and with the compiler that compiled netcdf, hdf5, mpi). 
    195 - The paths to libraries and include directories of hdf5, gcc, and netcdf-c are needed to make necessary modifications in installation files of ORCHIDEE. These packages are usually installed in "/usr/local/". When in doubt, check with your system administrator, or pass "nc-config --libdir" in command prompt. 
    196 - Configuration files for installation of ORCHIDEE is by default set for the clusters used by IPSL. The configuration files works well for their environments, however, we need to modify the configuration files and make them suitable for our system, then we can install without problem. 
    197 - You may install ORCHIDEE with gfortran and XIOS with gcc compilers, but I would like to suggest to use mpifort (or mpif90) and mpicc (i.e. the mpi wrapper versions of the compilers). mpicc and mpifort combines your compiler with the libraries of mpi, and makes it easier for ORCHIDEE to reach to mpi libraries during installation. 
     202- Above mentioned packages should be installed. These packages should be installed with same compiler to keep consistency and avoid problems later on. In the case of more than one package installation, make sure to keep consistency between packages and libraries used to install ORCHIDEE (example: XIOS and ORCHIDEE should be installed with the same netcdf library version, and with the same compiler that compiled NetCDF, hdf5, and MPI). 
     203- The paths to "lib" and "include" directories of hdf5, gcc, and netcdf-c are needed to make modifications in installation files of ORCHIDEE so that ORCHIDEE can find them. These packages are usually installed in "/usr/local/". When in doubt, check with your system administrator, or type "nc-config --libdir" in the command prompt (terminal window). 
     204- Configuration files for installation of ORCHIDEE are by default setup for the clusters used by IPSL. These configuration files work well for their environments, however, we need to modify the configuration files and make them suitable for our system, after which we can install without problems. 
     205- You may install ORCHIDEE with gfortran and XIOS using gcc compilers, but I would like to suggest to use mpifort (or mpif90) and mpicc (i.e. the mpi wrapped versions of the compilers). mpicc and mpifort combines your compiler with the libraries of mpi, and makes it easier for ORCHIDEE to reach to mpi libraries during installation.  As mentioned above, you can still run ORCHIDEE on a single processor even if it's been compiled in parallel mode. 
    198206  
    199207'''Step 1:  Download ORCHIDEE'''[[BR]] 
    200208 
    201 You need to install modipsl environment into a modipsl folder (you can change the name of this directory) : 
    202 {{{ 
    203       >  svn co http://forge.ipsl.jussieu.fr/igcmg/svn/modipsl/trunk modipsl 
    204 }}} 
    205  
    206 You can install a public or a private version of ORCHIDEE. [wiki:HowTo/InstallingORCHIDEEBasic Read more about installing different versions of ORCHIDEE.] To install the latest tagged version : 
    207 {{{ 
    208       > cd modipsl/util 
     209ORCHIDEE forms part of the IPSL Earth System Model.  As such, it sits within a collection of scripts that allow for coupling different components of the Earth system together, known as the modipsl environment.  An overview of the modipsl environment can be found [https://forge.ipsl.jussieu.fr/igcmg_doc/wiki/Doc/Install here]. 
     210 
     211The first step to installing ORCHIDEE is thus to install the modipsl environment into a folder.  This folder will eventually hold your ORCHIDEE model source code and the configuration files to run the simulation:   
     212{{{ 
     213      >  svn co http://forge.ipsl.jussieu.fr/igcmg/svn/modipsl/trunk MYDIRECTORY 
     214}}} 
     215 
     216MYDIRECTORY can be named whatever you find useful to remember what is special about this version of ORCHIDEE. 
     217 
     218You can install a public or a private version of ORCHIDEE. [wiki:HowTo/InstallingORCHIDEEBasic Read more about installing different versions of ORCHIDEE.] To install the latest tagged version (tagged versions are major releases): 
     219{{{ 
     220      > cd MYDIRECTORY/util 
    209221      > ./model ORCHIDEE_trunk 
    210222}}} 
    211223 
    212  
    213 {{{ 
    214       > cd modipsl/util 
     224To install older tagged version (e.g., 2.1 or 2.0): 
     225{{{ 
     226      > cd MYDIRECTORY/util 
    215227      > ./model ORCHIDEE_2_1 
    216228      or