Changes between Version 2 and Version 3 of Documentation/UserGuide/CompileMethods

Timestamp:

2014-05-27T10:20:40+02:00 (10 years ago)

Author:

jgipsl

Comment:

--

Documentation/UserGuide/CompileMethods

@@ -52 +52 @@
 === makeorchidee_fcm === 
 The script [https://forge.ipsl.jussieu.fr/orchidee/browser/trunk/ORCHIDEE/makeorchidee_fcm makeorchidee_fcm] compiles ORCHIDEE using the FCM, a software developed by the Hadley Centre. 
-While using this script the dependencies between fortran modules do not need to be set in advance. Fcm determines the dependencies. 
+While using this script the dependencies between fortran modules do not need to be set in advance. Fcm determines the dependencies. Fcm is stored in tools/ directory.
 
-Compile options for different target machines or compilers are defined in the directory ''arch/''. For each target machine two files must exist : archname.fcm and archname.path. Use ''./makeorchidee_fcm -h'' to get information about available arguments. See here the main arguments are [[BR]]
+Compile options for different target machines or compilers are defined in the directory ''arch/''. For each target machine two files must exist : archname.fcm and archname.path. Use ''./makeorchidee_fcm -h'' to get information about available arguments. See here the main arguments [[BR]]
 {{{
+./makeorchidee_fcm [Options] 
 
-./makeorchidee_fcm -h
+[ -h ]        : show this help
 
-########################################################################
-# Manuel en ligne
-########################################################################
-more <<eod
+[ -arch XXX ] : name of the archicture file containg platform dependent compile options. 
+                The files arch/arch-XXX.fcm and arch/arch-XXX.path must exist. 
 
+[ -parallel|-p PARALLEL_TYPE ] : choose parallelization mode for ORCHIDEE : 
+    PARALLEL_TYPE =
+    ( mpi | MPI )              : only MPI (Message Passing Interface)
+    ( omp | OMP )              : only OpenMP
+    ( mpi_omp | MPI_OMP )      : hybrid MPI/OpenMP mode
+    ( none | NONE | seq )      : sequential mode (default)
 
-makeorchidee_fcm [Options] 
+[ -driver ]      : compilation of ORCHIDEE offline driver (default compiling only the library)
 
-[ -parallel|-p PARALLEL_TYPE ] : activate parallelization with 3 options : 
-    PARALLEL_TYPE =
-    ( mpi | MPI )  : use Message Passing Interface standard
-    ( omp | OMP )  : use OpenMP standard
-    ( mpi_omp | MPI_OMP ) : use both MPI and OpenMP
-    ( none | NONE | seq ) : sequential mode (default)
-[ -driver ] : compilation of ORCHIDEE driver if equal TRUE
-[ -arch ARCHitecture ] : if TRUE, change architecture for ARCHitecture
-[ -xios ] : compilation with XIOS
-[ -noxios ] : compilation without XIOS
-[ -prod ] : compilation for production (all optimization)
-[ -dev ] : compilation for development (low optimization and -g)
-[ -d|-debug ] : compilation for debugging (no optmization and all debug options)
-| -full ] : activate full recompiling 
-| -clean ] : delete all files produceed during previous compilation
-[ -j x ] : activate parallel compiling on x task, default 1 task
-[ -ext_src path] : path to an additional set of routines to compile with the model
+Options related to cleaning
+| -clean ]       : delete all files produceed during previous compilation
+| -full ]        : activate full recompiling 
+
+Options for XIOS, only choose one of the following
+[ -xios ]        : linking with XIOS
+[ -noxios ]      : compilation without XIOS (default)
+
+Options for optimization, choose only one of the following
+[ -prod ]        : compilation for production (all optimization)
+[ -dev ]         : compilation for development (low optimization and -g)
+[ -debug ]       : compilation for debugging (no optmization and all debug options)
+
+Option to optimize the compilation time
+[ -j x ]         : activate parallel compiling on x task, default 1 task
+
+Option to add extra source to compile
+[ -ext_src path] : path to an additional directory with fortran routines to compile with the model
 }}}
  
 
 Using fcm, the dependencies between the modules are not predefined. fcm will determine the correct order to compile. makeorchidee_fcm do not compile IOIPSL. This must be done in advance. [[BR]]
-
-Example 1 : compile at curie for MPI parallel run mode 
+Example 1 : compile at curie(TGCC) for MPI parallel run mode
 {{{
-./makeorchidee_fcm -parallel mpi -arch X64_CURIE -driver
-}}}
-
-Example 2 : compile at ada for MPI-OpenMP parallel run mode 
-{{{
-./makeorchidee_fcm -parallel mpi_omp -arch X64_CURIE -driver
+   ./makeorchidee_fcm -parallel mpi -arch X64_CURIE -driver
 }}}
 
 
-Example 3 : compile using gfortran compiler for sequential run mode (make sure that the files arch/gfortran.fcm and arch/gfortran.path are suitable for your environement especially the path to netcdf library)
+Example 2 : compile at ada(IDRIS) for MPI-OpenMP parallel run mode
 {{{
-./makeorchidee_fcm -parallel seq -arch gfortran -driver
+   ./makeorchidee_fcm -parallel mpi_omp -arch X64_ADA -driver
 }}}
 
 
-Example 4 : clean files created during previous compilation
+Example 3 : compile at obelix(LSCE)
 {{{
-./makeorchidee_fcm -clean
+   ./makeorchidee_fcm -arch ifort_LSCE -driver
 }}}
+
+Example 4 : compile using gfortran compiler for sequential run mode 
+First make sure that the files arch/gfortran.fcm and arch/gfortran.path are suitable for 
+your environement especially the path to netcdf library. 
+{{{
+   ./makeorchidee_fcm -parallel seq -arch gfortran -driver
+}}}
+
+
+Example 5 : clean files created during previous compilation
+{{{
+   ./makeorchidee_fcm -clean
+}}}
+