New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
Users/ModelInstall (diff) – NEMO

Changes between Version 28 and Version 29 of Users/ModelInstall


Ignore:
Timestamp:
2017-05-12T17:01:51+02:00 (7 years ago)
Author:
nicolasmartin
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Users/ModelInstall

    v28 v29  
    44 
    55[[PageOutline(2-3)]] 
    6 \\ 
    7 \\ 
    8 \\ 
    9 \\ 
    10 \\ 
    11 \\ 
    12 \\ 
    13 \\ 
    14 \\ 
    15 \\ 
    16  
    17  
    18  
    196 
    207== 1. Extract the NEMO code 
     
    3017The image below shows the directory tree: 
    3118 
    32 [[Image(Users/ModelInstall:nemogcm_tree.png,width=300)]] 
     19[[Image(wiki:Users/ModelInstall:nemogcm_tree.png,width=600, center)]] 
    3320 
    3421 
     
    4431Diagnostic outputs from NEMO are handled by the third party XIOS library. '''Important notice: XIOS needs to be installed (dowloaded and compiled) before NEMO, since the libraries are needed to successfully create NEMO executable.'''  Instructions on how to obtain and install the software see [[ModelInterfacing/InputsOutputs#ExtractingandinstallingXIOS]]. 
    4532 
    46 When you compile NEMO you will need to specify the following cpp keys: 
     33When you compile NEMO you will need to specify the following CPP keys: 
    4734   * key_iomput 
    4835   * key_mpp_mpi (if you want to use "detached mode") 
     
    5946As an example, compile `GYRE`, with ifort on linux to create a `MY_GYRE` configuration: 
    6047{{{#!sh 
    61  cd NEMOGCM/CONFIG; ./makenemo –m my_arch_name –r GYRE -n MY_GYRE 
     48cd NEMOGCM/CONFIG; ./makenemo –m "my_arch_name" –r GYRE -n MY_GYRE 
    6249}}} 
    6350 
    6451After successful execution of the makenemo command, the executable name `opa`is created in the EXP00 directory (in the example above, the executable is created in `CONFIG/MY_GYRE/EXP00/opa`) 
    6552{{{#!comment 
    66 The image below shows the directory tree characterized by  'MY_CONFIG' new 'branch'. All directories and fundamental files created by makenemo are highlighted in green.  
     53The image below shows the directory tree characterized by [[span("MY_CONFIG", style=color: #BB4444 )]] new 'branch'. All directories and fundamental files created by makenemo are highlighted in green.  
    6754In particular, even if not shown in the figure, the "WORK" folder contains links to the compiled routines. 
    6855 
    6956[[Image(Users/ModelInstall:nemogcm_tree._compiled.png,width=300)]] 
    70 ADD here new figure with all the directories and files created by makenemo: the excutable, but also the directories and their content: WORK, BLD, etc... 
     57ADD here new figure with all the directories and files created by makenemo: the executable, but also the directories and their content: `WORK`, `BLD`, etc... 
    7158This should be the same figure as baobe, with all new files and directories added with another color. 
    7259}}} 
     
    10794makenemo –n ORCA_LIM3_v2 -r ORCA_LIM3 
    10895}}} 
    109 * Create and compile ORCA2_LIM_2_2, add (`add_key`) and delete (`del_key`) keys, based on `ORCA2_LIM` 
     96* Create and compile ORCA2_LIM_2_2, add (`add_key`) and delete (`del_key`) keys, based on ORCA2_LIM 
    11097{{{#!sh 
    11198makenemo –n ORCA2_LIM_2_2 -r ORCA2_LIM del_key "key_iomput" # and answer 
     
    122109== 5. Running the model 
    123110 
    124 Once makenemo has run successfully, the executable is available in `CONFIG/"MY_CONFIG"/EXP00/opa` 
    125 For the reference configurations, the `EXP00`directory also contains the small ASCII input file (namelists, *xml files for the IOs...). If the configuration also needs NETCDF input files, this should be downloaded into the `EXP00` directory from the corresponding tarfile, see  [http://forge.ipsl.jussieu.fr/nemo/wiki/Users/ReferenceConfigurations] 
     111Once `makenemo` has run successfully, the `opa` executable is available in `CONFIG/"MY_CONFIG"/EXP00`[[BR]] 
     112For the reference configurations, the `EXP00`directory also contains the small ASCII input file (namelists, *xml files for the IOs...). If the configuration also needs NetCDF input files, this should be downloaded into the `EXP00` directory from the corresponding tarfile, see [wiki:Users/ReferenceConfigurations] 
    126113 
    127 === Run the model 
    128  
    129 {{{ 
     114{{{#!sh 
    130115cd CONFIG/"MY_CONFIG"/EXP00 
    131 mpirun -n "NP" ./opa    # NP is the number of processes ; mpirun is your MPI wrapper 
     116mpirun -n $NPROCS ./opa    # $NPROCS is the number of processes ; mpirun is your MPI wrapper 
    132117}}} 
    133118 
     119== 6. Viewing and changing list of active CPP keys 
    134120 
    135  
    136 == Viewing and changing list of active cpp keys 
    137  
    138 For a given configuration (here called "MY_CONFIG", the list of active cpp keys can be found in  
    139 {{{ 
     121For a given configuration (here called [[span("MY_CONFIG", style=color: #BB4444 )]]), the list of active CPP keys can be found in  
     122{{{#!sh 
    140123NEMOGCM/CONFIG/"MYCONFIG"/cpp_"MY_CONFIG".fcm 
    141124}}} 
    142125 
    143 This text file can be edited to change the list of active cpp keys. Once changed, one needs to recompile NEMO using the makenemo command in order for this change to be taken in account. 
     126This text file can be edited to change the list of active CPP keys. Once changed, one needs to recompile NEMO using `makenemo` command in order for this change to be taken in account.