Changeset 10561


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

update tools.rst file

File:
1 edited

Legend:

Unmodified
Added
Removed
  • utils/tools/README.rst

    r10279 r10561  
    1 ********* 
    2 Utilities 
    3 ********* 
     1TOOLS 
     2===== 
    43 
    54.. contents:: 
    6    :local: 
     5           :local: 
    76 
    8 AGRIF nesting tool 
    9 ================== 
     7A set of tools is provided with NEMO to setup user own configuration and (pre|post)process data. 
    108 
    11 How to create the grid coordinates, the surface forcing and the initial conditions required by each child model. 
     9How to compile a tool 
    1210 
    13 Data interpolation with CDO 
    14 =========================== 
     11The tool can be compiled using the maketools script in the tools directory as follows: 
    1512 
    16 The aim is to remap from/to a regular geographic grid to/from an other curvilinear grid, especially the ORCA one. 
     13.. code-block:: console 
     14        $ ./maketools -m '$ARCH' -n '<TOOL_NAME>' 
    1715 
    18 Data compression 
    19 ================ 
     16where ``$ARCH`` can be selected among available architecture files or providing a user defined one. 
    2017 
    21 For netdcf files: example for COREII forcing files. 
     18DMP_TOOLS 
     19--------- 
    2220 
    23 Weight creation for online interpolation 
    24 ======================================== 
     21Used 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>`_). 
    2522 
    26 See here and here. 
     23DOMAINcfg 
     24--------- 
    2725 
    28 Bathymetry 
    29 ========== 
     26This 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>`_). 
    3027 
    31 OPABAT is a group of Fortran and IDL routines which allows to build a bathymetry on the grid of 
    32 the dynamical oceanic part, OPA. 
     28GRIDGEN 
     29------- 
    3330 
    34 Data interpolation 
    35 ================== 
     31A toolbox allowing the creation of regional configurations from curvilinear grid (see `reference guide <http://forge.ipsl.jussieu.fr/nemo/browser/utils/tools/GRIDGEN/doc_cfg_tools.pdf>`_ ). 
    3632 
    37 The aim is to remap from a regular geographic grid to an other curvilinear grid, especially the ORCA one. 
    38 It will be provide by `SOSIE <http://sosie.sourceforge.net>`_. 
     33MISCELLANEOUS 
     34------------- 
    3935 
    40 Setting up MPP configuration tool 
    41 ================================= 
     36The tool allows to create alternative configurations to the community without having to rely on system team sponsorship and support. 
    4237 
    43 This Fortran based tool provides to the user information to choose the best domain decomposition. 
    44 The proposed solution will be the one with an optimized number of processos in 
    45 suppressing eventual useless land processors. 
     38MPP_PREP 
     39-------- 
    4640 
    47 - Documentation: mpp_nc.pdf mpp_nc.pdf 
    48 - Tar file     : mpp_prep-1.0.tar.gz 
     41This tool provides the user with information to choose the best domain decomposition. 
     42The tool computes the number of water processors for all possible decompositions (up to a maximum number of processors).  
     43Documentation: `mpp_nc.pdf <http://forge.ipsl.jussieu.fr/nemo/attachment/wiki/Users/SetupNewConfiguration/mpp_nc.pdf>`_ 
     44Tar file     : `mpp_prep-1.0.tar.gz <http://forge.ipsl.jussieu.fr/nemo/attachment/wiki/Users/SetupNewConfiguration/mpp_prep-1.0.tar.gz>`_ 
    4945 
    50 Conversion of restart files 
    51 =========================== 
     46NESTING 
     47------- 
    5248 
    53 This Fortran based tool performs light changes on restart files (NetCDF or DIMG format) to 
    54 ensure their compatibility with the new IOM package in the standard version of NEMO i.e. since 
    55 the tag nemo_v2 and later: Chge_Rst_files.tar 
     49AGRIF 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>`_). 
    5650 
    57 ORCA grids generator 
    58 ==================== 
     51OBSTOOLS 
     52-------- 
    5953 
    60 This Fortran based tool allows to generate an ORCA grid type: gridgen_CECILL.tar 
     54A series of Fortran utilities which are helpful in handling observation files and the feedback file output from the NEMO observation operator. 
     55Further info are available in the Nemo manual. 
     56 
     57REBUILD_NEMO 
     58------------ 
     59 
     60REBUILD_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>`_). 
     61 
     62REBUILD 
     63------- 
     64 
     65It contains the old version of REBUILD_NEMO tool based on the IOIPSL code. 
     66 
     67SCOORD_GEN 
     68---------- 
     69 
     70Offline tool to generate a vertical coordinates input file for use with S coordinates. This has been carried out by copying the model code to an offline tool and then modifying it to suppress the use of 3D arrays (to reduce memory usage). The tool has been created in preparation for the removal of the vertical grid definition from the code. The output file should contain all variables that are necessary to restart the model. 
     71 
     72SECTIONS_DIADCT 
     73--------------- 
     74 
     75When the Transport across sections diagnostic is activated (``key_diadct``), this tool is used to build the binary file containing the pathways between the extremities of each section. 
     76Further info are available in the Nemo manual. 
     77 
     78SIREN 
     79----- 
     80 
     81SIREN 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>`_) 
     82 
     83WEIGHTS 
     84------- 
     85 
     86This 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>`_) 
Note: See TracChangeset for help on using the changeset viewer.