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

Timestamp:

2020-02-28T11:24:12+01:00 (4 years ago)

Author:

mmcgrath

Comment:

--

Documentation/UserGuide/InstallingORCHIDEE

@@ -5 +5 @@
 Last revision: 2020/02/28, M. McGrath
 
-* The general method on how to install the IGCM computing environment (which ORCHIDEE can run in) is found here: https://forge.ipsl.jussieu.fr/igcmg_doc/wiki/Doc#Installaconfiguration
+* 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
 * If you have an account at LSCE, IDRIS or the TGCC computers, follow the procedure to download and compile ORCHIDEE as described here: [wiki:Documentation/UserGuide/InstallingORCHIDEEBasic]'''
 * The text below contains more details about installing libraries and ORCHIDEE with gfortran on a personal Linux computer.  If the libraries already exist on your computer, you can may be able to use the above pages.
 
 This installation guide has been tested on a laptop computer using Ubuntu 16.04 version.
-Software used : mpicc (C compiler with mpi libraries wrapped into it), mpifort (or mpif90) (Fortran 90 compiler with mpi libraries wrapped on it), subversion (version control system), netcdf 4.6.1 [[BR]]
+Software used : mpicc (C compiler with MPI libraries wrapped around it), mpifort (or mpif90) (Fortran 90 compiler with MPI libraries wrapped around it), subversion (version control system), netcdf 4.6.1 [[BR]]
 Follow the steps below and you should be able to compile and launch ORCHIDEE on a single processor for a single site.
 
@@ -64 +64 @@
 The netcdf package should be linked to previously installed packages (szlib, openmpi, hdf5) during configuration before compilation. Different options for build configurations of the netcdf-c package installation are given at [https://www.unidata.ucar.edu/software/netcdf/docs/getting_and_building_netcdf.html].[[BR]]
 
-To be able to see different configuration options, we can command
+To be able to see different configuration options, we can type
 
 {{{
@@ -70 +70 @@
 }}}
 
-This command returns rather a long list of options that we can use building our package in the system. Crucial point here is to make sure the netcdf-C package that we want to install has:
-
-HDF5 Support
-
-This can be checked by configuring the installation folder once by:
-
+This command returns rather a long list of options that we can use to build (compile and link) the package. The crucial point here is to make sure the netcdf-C package that we want to install has HDF5 Support.
+
+This can be checked by configuring the installation folder:
 
 {{{
@@ -81 +78 @@
 }}}
 
-Which returns a table like this:
-
-
-{{{
-
+Which outputs a large number of "Checking" lines and finishes with a table like this:
+
+
+{{{
 # NetCDF C Configuration Summary
 ==============================
@@ -91 +87 @@
 # General
 -------
-NetCDF Version:         4.7.0
-Configured On:          Mon Aug  5 15:55:30 CEST 2019
+NetCDF Version:         4.7.3
+Dispatch Version:       1
+Configured On:          Fri Feb 28 11:01:24 CET 2020
 Host System:            x86_64-pc-linux-gnu
-Build Directory:        /home/#USERNAME#/Téléchargements/libs/netcdf-c-4.7.0
+Build Directory:        /home/jgipsl/netcdf-c-4.7.3
 Install Prefix:         /usr/local
 
@@ -108 +105 @@
 Shared Library:         yes
 Static Library:         yes
-Extra libraries:        -lhdf5_hl -lhdf5 -lm -ldl -lz -lcurl 
+Extra libraries:        -lhdf5_hl -lhdf5 -lm -lcurl 
 
 # Features
@@ -127 +124 @@
 ERANGE Fill Support:    no
 Relaxed Boundary Check: yes
-}}}
-
-''' Important:  Installation of ORCHIDEE requires us to know about the destination of these libraries, especially netcdf, the compiler, and HDF5. It is important to take note of the installation destination of each library, which will be used later. The installation destination can be imposed at "./configure" step by "--prefix" option'''
-
-To complete installation, type :
+
+}}}
+
+''' Important:  Installation of ORCHIDEE requires us to know about the location of these libraries, in particular netcdf, the compiler, and HDF5. It is important to take note of the installation destination of each library, which will be used later. The installation destination can be specified at "./configure" step by "--prefix" option.'''  If this is missing, the package will be installed at a default location (found by looking for the "Install Prefix:" line after running the configure command above).
+
+To complete the installation, type :
 {{{
       >  sudo su
@@ -139 +137 @@
       >  su
 }}}
-Enter your password then execute in the following order :
+Enter your password then execute the following commands in order:
 
 {{{
       > make
 }}}
-( compile netcdf on your computer.)
+( compiles NetCDF on your computer)
 Then
 {{{
       > make check
 }}}
-( Test the buiding )
+( test the compilation )
 and finally the installation :
 
@@ -155 +153 @@
       > make install
 }}}
-
-If your installation was successful, the following message will appears :
+(copies the files to their final destination)
+
+If your installation was successful, the following message will appear:
 
 {{{