Changeset 10563


Ignore:
Timestamp:
2019-01-23T17:33:32+01:00 (18 months ago)
Author:
francesca
Message:

update tools.rst file

File:
1 edited

Legend:

Unmodified
Added
Removed
  • utils/tools/README.rst

    r10561 r10563  
    77A set of tools is provided with NEMO to setup user own configuration and (pre|post)process data. 
    88 
    9 How to compile a tool 
     9**How to compile a tool** 
    1010 
    1111The tool can be compiled using the maketools script in the tools directory as follows: 
    1212 
    1313.. code-block:: console 
     14 
    1415        $ ./maketools -m '$ARCH' -n '<TOOL_NAME>' 
    1516 
     
    1920--------- 
    2021 
    21 Used to create a netcdf file called ``resto.nc`` containing restoration coefficients for use with the tra_dmp module in NEMO (see `README <http://forge.ipsl.jussieu.fr/nemo/browser/utils/tools/DMP_TOOLS/README>`_). 
     22Used to create a netcdf file called ``resto.nc`` containing restoration coefficients for use with the tra_dmp module in NEMO (see `DMP_TOOLS README <http://forge.ipsl.jussieu.fr/nemo/browser/utils/tools/DMP_TOOLS/README>`_). 
    2223 
    2324DOMAINcfg 
    2425--------- 
    2526 
    26 This tool allows the creation of a domain configuration file (``domain_cfg.nc``) containing the ocean domain information required to define an ocean configuration from scratch. (see `README <http://forge.ipsl.jussieu.fr/nemo/browser/utils/tools/DOMAINcfg/README>`_). 
     27This tool allows the creation of a domain configuration file (``domain_cfg.nc``) containing the ocean domain information required to define an ocean configuration from scratch. (see `DOMAINcfg README <http://forge.ipsl.jussieu.fr/nemo/browser/utils/tools/DOMAINcfg/README>`_). 
    2728 
    2829GRIDGEN 
     
    4748------- 
    4849 
    49 AGRIF nesting tool allows for the seamless two-way coupling of nested sub-models within the NEMO framework as long as these are defined on subsets of the original root grid. It allows to create the grid coordinates, the surface forcing and the initial conditions required by each sub-model when running a NEMO/AGRIF embedded mode (see `README <http://forge.ipsl.jussieu.fr/nemo/browser/utils/tools/NESTING/README>`_). 
     50AGRIF nesting tool allows for the seamless two-way coupling of nested sub-models within the NEMO framework as long as these are defined on subsets of the original root grid. 
     51It allows to create the grid coordinates, the surface forcing and the initial conditions required by each sub-model when running a NEMO/AGRIF embedded mode (see `NESTING README <http://forge.ipsl.jussieu.fr/nemo/browser/utils/tools/NESTING/README>`_). 
    5052 
    5153OBSTOOLS 
     
    5860------------ 
    5961 
    60 REBUILD_NEMO is a tool to rebuild NEMO output files from multiple processors (mesh_mask, restart or XIOS output files) into one file (see `README <http://forge.ipsl.jussieu.fr/nemo/browser/utils/tools/REBUILD_NEMO/README.rst>`_). 
     62REBUILD_NEMO is a tool to rebuild NEMO output files from multiple processors (mesh_mask, restart or XIOS output files) into one file (see `REBUILD_NEMO README <http://forge.ipsl.jussieu.fr/nemo/browser/utils/tools/REBUILD_NEMO/README.rst>`_). 
    6163 
    6264REBUILD 
     
    7981----- 
    8082 
    81 SIREN is a configuration management tool to set up regional configurations with NEMO. (see `README <http://forge.ipsl.jussieu.fr/nemo/browser/utils/tools/SIREN/README>`_) 
     83SIREN is a configuration management tool to set up regional configurations with NEMO. (see `SIREN README <http://forge.ipsl.jussieu.fr/nemo/browser/utils/tools/SIREN/README>`_) 
    8284 
    8385WEIGHTS 
    8486------- 
    8587 
    86 This directory contains software for generating and manipulating interpolation weights for use with the Interpolation On the Fly (IOF) option in NEMO v3 onwards. (see `README <http://forge.ipsl.jussieu.fr/nemo/browser/utils/tools/WEIGHTS/README>`_) 
     88This directory contains software for generating and manipulating interpolation weights for use with the Interpolation On the Fly (IOF) option in NEMO v3 onwards. (see `WEIGHTS README <http://forge.ipsl.jussieu.fr/nemo/browser/utils/tools/WEIGHTS/README>`_) 
Note: See TracChangeset for help on using the changeset viewer.