Changes between Version 5 and Version 6 of Users/Model Install


Ignore:
Timestamp:
2017-04-12T18:41:23+02:00 (3 years ago)
Author:
nicolasmartin
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Users/Model Install

    v5 v6  
    11= Install the modelling framework (NEMO and XIOS) 
    2 '''1-1 Extract the NEMO code'''[[BR]] 
    32 
    4 Using your "my_login" /pw registered on this web site:[[BR]][[BR]] 
     3== 1. Extract the NEMO code 
    54 
    6 {{{ 
     5Using your `my_login` /pw registered on this web site: 
     6{{{#!sh 
    77svn --username "mylogin" co http://forge.ipsl.jussieu.fr/nemo/svn/branches/2015/nemo_v3_6_STABLE/NEMOGCM 
    88}}} 
    9 [[BR]][[BR]] 
    10 '''1-2 Extract and install XIOS'''[[BR]][[BR]] 
    11 [http://www.nemo-ocean.eu/Using-NEMO/User-Guides/Basics/XIOS-IO-server-installation-and-use Document here] (and come back to this page afterwards to create NEMO executable!)[[BR]][[BR]] 
    129 
     10== 2. Extract and install XIOS 
    1311 
    14 '''1-3 Compile and create NEMO executable'''[[BR]][[BR]][[BR]] 
    15 The main script to compile and create executable is called makenemo and located in the CONFIG directory.To identify the source code you need, to build the makefile and run it.[[BR]][[BR]] 
    16 As an example, compile GYRE, with ifort on linux to create a MY_GYRE configuration:[[BR]][[BR]] 
     12[http://www.nemo-ocean.eu/Using-NEMO/User-Guides/Basics/XIOS-IO-server-installation-and-use Document here] (and come back to this page afterwards to create NEMO executable!) 
    1713 
     14== 3. Compile and create NEMO executable 
    1815 
    19 {{{ 
     16The main script to compile and create executable is called `makenemo` and located in the `CONFIG` directory. To identify the source code you need, to build the makefile and run it.[[BR]] 
     17As an example, compile `GYRE`, with ifort on linux to create a `MY_GYRE` configuration: 
     18{{{#!sh 
    2019cd NEMOGCM/CONFIG; ./makenemo –m ifort_linux –r GYRE -n MY_GYRE 
    2120}}} 
    22 [[BR]] 
    23 [[BR]] 
    24 '''More options:'''[[BR]][[BR]] 
    2521 
    26 * –n CONFIG : for configuration name, existant or new config to install[[BR]] 
     22=== More options 
    2723 
    28 * –m COMPILER : compiler choice (use files names in NEMOGCM/ARCH, see examples below)[[BR]] 
     24* `–n` CONFIG : for configuration name, existant or new config to install 
     25* `–m` COMPILER : compiler choice (use files names in `NEMOGCM/ARCH`, see examples below) 
     26* `–h`: help 
     27* `–r` REFCONFIG : reference configuration as first guess when installing a new one 
     28* `–j`: number of processes to compile (`-j 0`:no compilation) 
     29* `–d`: NEMO subdirectory (not needed) 
     30* `–t` DIR : temporary directory to store libraries 
     31* `-clean` [CONFIG_NAME] : remove the Makefile and all the files created afterwards 
    2932 
    30 *  –h help[[BR]] 
     33At the first use, you need the `-m` option to specify compiler, its options and libraries, then for next compilation, it is assumed you will be using the same compiler.[[BR]] 
     34If `–n` option is not specified, `ORCA2_LIM` is the default configuration used. `-d` option has been implemented for use in non-interactive shell. The `WORK` directory is created under each configuration directory. 
    3135 
    32  * –r REFCONFIG : reference configuration as first guess when installing a new one[[BR]] 
     36=== Tools used during the process 
    3337 
    34  * –j 4 : number of processes to compile (j=0 :no compilation)[[BR]] 
     38* `functions.sh` : bash functions used by `makenemo`, for instance to create the `WORK` directory 
     39* `cfg.txt` : text list of configurations and source directories[[BR]] 
     40* `bld.cfg` : FCM rules to compile 
    3541 
    36 * –d “ “ : NEMO subdirectory (not needed)[[BR]] 
     42=== Description of directories 
    3743 
    38 * –t DIR : temporary directory to store libraries[[BR]] 
     44* `ARCH` : compilation option files, with format `arch_compiler.fcm`, the compiler name has to be provided with `–m` option 
     45* `GYRE`, `ORCA2_LIM` or others : there is now a `cpp.fcm` file containing the list of cpp key, the `WORK` is specific to each configuration 
    3946 
    40 * -clean [CONFIG_NAME] : remove the Makefile and all the files created afterwards[[BR]] 
    41 [[BR]] 
     47== Examples 
    4248 
    43 At the first use, you need the -m option to specify compiler, its options and libraries, then for next compilation, it is assumed you will be using the same compiler. 
    44 If –n option is not specified, ORCA2_LIM is the default configuration used. -d option has been implemented for use in non-interactive shell. The WORK directory is created under each configuration directory.[[BR]][[BR]] 
    45  
    46 '''Tools used during the process:'''[[BR]][[BR]] 
    47 * functions.sh : bash functions used by makenemo, for instance to create the WORK directory[[BR]] 
    48 * cfg.txt : text list of configurations and source directories[[BR]] 
    49 * bld.cfg : FCM rules to compile[[BR]] 
    50 '''Description of directories :'''[[BR]][[BR]] 
    51 * ARCH : compilation option files, with format arch_compiler.fcm, the compiler name has to be provided with –m option[[BR]] 
    52 * GYRE, ORCA2_LIM or others : there is now a cpp.fcm file containing the list of cpp key, the WORK is specific to each configuration[[BR]][[BR]] 
    53 [[BR]] 
    54 = Examples:[[BR]][[BR]] 
    5549Compiling GYRE, with ifort on linux to create a MY_GYRE configuration[[BR]] 
    56 [[BR]] 
    57 {{{ 
     50{{{#!sh 
    5851makenemo –m ifort_linux –r GYRE -n MY_GYRE 
    5952}}} 
    60 [[BR]] 
     53 
    6154Recompile it[[BR]] 
    62 [[BR]] 
    63 {{{ 
     55{{{#!sh 
    6456makenemo 
    6557}}} 
    66 [[BR]] 
     58 
    6759Now, create and compile ORCA_LIM3[[BR]] 
    68 [[BR]] 
    69 {{{ 
     60{{{#!sh 
    7061makenemo –n ORCA_LIM3 (and answer) 
    7162}}} 
    72 [[BR]] 
     63 
    7364Now ORCA_LIM3_v2 based on the previous one[[BR]] 
    74 [[BR]] 
    75 {{{ 
     65{{{#!sh 
    7666makenemo –n ORCA_LIM3_v2 -r ORCA_LIM3 
    7767}}} 
    78 [[BR]] 
    79 Now, create and compile ORCA2_LIM_2_2, add ('''add_key''') and delete ('''del_key''') keys, based on ORCA2_LIM (just un example)[[BR]] 
    80 [[BR]] 
    81 {{{ 
     68 
     69Now, create and compile ORCA2_LIM_2_2, add ('''add_key''') and delete ('''del_key''') keys, based on ORCA2_LIM (just un example) 
     70{{{#!sh 
    8271makenemo –n ORCA2_LIM_2_2 -r ORCA2_LIM del_key "key_iomput" (and answer) 
    8372}}} 
    84 [[BR]] 
    85 To remove a bad configuration[[BR]][[BR]] 
    8673 
    87 {{{ 
     74To remove a bad configuration 
     75{{{#!sh 
    8876makenemo –n ORCA2_LIM_2_2 clean_config (and answer) 
    8977}}} 
    90  
    91  
    92  
    93