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

Timestamp:

2020-02-28T10:58:22+01:00 (4 years ago)

Author:

mmcgrath

Comment:

--

Documentation/UserGuide/InstallingORCHIDEE

@@ -13 +13 @@
 Follow the steps below and you should be able to compile and launch ORCHIDEE on a single processor for a single site.
 
-ORCHIDEE can be installed in serial (single processor) or parallel (multiple processors) mode. This installation is oriented for parallel installation. One can always run ORCHIDEE with a single processor even if the compilation was done for a parallel mode, but the opposite is not true (a serial executable cannot be run on multiple processors).  The installation requires a few packages to be installed on the system before starting installation of ORCHIDEE. These are:
+ORCHIDEE can be installed in serial (single processor) or parallel (multiple processors) mode. This installation is oriented for parallel installation, which is the default, and MPI libraries are mature enough that they typically install easily. One can always run ORCHIDEE with a single processor even if the compilation was done for a parallel mode, but the opposite is not true (a serial executable cannot be run on multiple processors).  The installation requires a few packages to be installed on the system before starting installation of ORCHIDEE. These are:
 
 * szlib
@@ -44 +44 @@
 === 1.b Manual installation ===
 
-Installing NetCDF without a package manager is a bit tricky, since it requires linking to libraries in other packages. A library is a set files comprising functions inside packages (for example, the NetCDF library has a function that enables you to read the information in a NetCDF file). Each package carry a set of functions defined in libraries. Current programs (in this case ORCHIDEE) rely on many packages working together, therefore, we need to link these packages during installation. 
+Installing NetCDF without a package manager is a bit tricky, since it requires linking to libraries in other packages. A library is a set files comprising functions inside packages (for example, the NetCDF library has a function that enables you to read the information in a NetCDF file). A package is a compressed file archive containing all of the files that come with a particular application (e.g., libraries, files with pre-defined variables). Current programs (in this case ORCHIDEE) rely on many packages working together, and therefore we need to link these packages to ORCHIDEE during installation. 
+
+Installation of a package requires: 1) downloading the source code, 2) unpacking it from the compressed form, 3) configuring the package, 4) compiling the package, and 5) putting executable and library files into standard locations on your computer.
 
 Download netcdf-c :
-Open a terminal and type the following command (> represents the prompt) to download netcdf version X.Y.Z : 
-{{{
-    >   wget http://www.unidata.ucar.edu/downloads/netcdf/ftp/netcdf-c-X.Y.Z.tar.gz
+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) : 
+{{{
+    >   wget https://www.unidata.ucar.edu/downloads/netcdf/ftp/netcdf-c-X.Y.Z.tar.gz
 }}}
 Extract the archive :
@@ -60 +62 @@
 }}}
 
-The netcdf package should be linked to previously installed packages (szlib, openmpi, hdf5) at the configuration of package before installation. Different options for build configuration of netcdf-c package installation is given at [https://www.unidata.ucar.edu/software/netcdf/docs/getting_and_building_netcdf.html].[[BR]]
+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