source: utils/tools/README.rst @ 10563

Last change on this file since 10563 was 10563, checked in by francesca, 19 months ago

update tools.rst file

File size: 3.9 KB
Line 
1TOOLS
2=====
3
4.. contents::
5           :local:
6
7A set of tools is provided with NEMO to setup user own configuration and (pre|post)process data.
8
9**How to compile a tool**
10
11The tool can be compiled using the maketools script in the tools directory as follows:
12
13.. code-block:: console
14
15        $ ./maketools -m '$ARCH' -n '<TOOL_NAME>'
16
17where ``$ARCH`` can be selected among available architecture files or providing a user defined one.
18
19DMP_TOOLS
20---------
21
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>`_).
23
24DOMAINcfg
25---------
26
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>`_).
28
29GRIDGEN
30-------
31
32A 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>`_ ).
33
34MISCELLANEOUS
35-------------
36
37The tool allows to create alternative configurations to the community without having to rely on system team sponsorship and support.
38
39MPP_PREP
40--------
41
42This tool provides the user with information to choose the best domain decomposition.
43The tool computes the number of water processors for all possible decompositions (up to a maximum number of processors).
44Documentation: `mpp_nc.pdf <http://forge.ipsl.jussieu.fr/nemo/attachment/wiki/Users/SetupNewConfiguration/mpp_nc.pdf>`_
45Tar file     : `mpp_prep-1.0.tar.gz <http://forge.ipsl.jussieu.fr/nemo/attachment/wiki/Users/SetupNewConfiguration/mpp_prep-1.0.tar.gz>`_
46
47NESTING
48-------
49
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>`_).
52
53OBSTOOLS
54--------
55
56A series of Fortran utilities which are helpful in handling observation files and the feedback file output from the NEMO observation operator.
57Further info are available in the Nemo manual.
58
59REBUILD_NEMO
60------------
61
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>`_).
63
64REBUILD
65-------
66
67It contains the old version of REBUILD_NEMO tool based on the IOIPSL code.
68
69SCOORD_GEN
70----------
71
72Offline 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.
73
74SECTIONS_DIADCT
75---------------
76
77When 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.
78Further info are available in the Nemo manual.
79
80SIREN
81-----
82
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>`_)
84
85WEIGHTS
86-------
87
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 TracBrowser for help on using the repository browser.