source: utils/tools/README.rst @ 10561

Last change on this file since 10561 was 10561, 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
9How 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        $ ./maketools -m '$ARCH' -n '<TOOL_NAME>'
15
16where ``$ARCH`` can be selected among available architecture files or providing a user defined one.
17
18DMP_TOOLS
19---------
20
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>`_).
22
23DOMAINcfg
24---------
25
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>`_).
27
28GRIDGEN
29-------
30
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>`_ ).
32
33MISCELLANEOUS
34-------------
35
36The tool allows to create alternative configurations to the community without having to rely on system team sponsorship and support.
37
38MPP_PREP
39--------
40
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>`_
45
46NESTING
47-------
48
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>`_).
50
51OBSTOOLS
52--------
53
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 TracBrowser for help on using the repository browser.