source: utils/tools/README.rst @ 11751

Last change on this file since 11751 was 11751, checked in by nicolasmartin, 12 months ago

Review README for tools

File size: 4.2 KB
Line 
1*****
2Tools
3*****
4
5.. todo::
6
7   The 'Tools' chapter needs to be enriched
8
9.. contents::
10   :local:
11   :depth: 1
12
13A set of tools is provided with NEMO to setup user own configuration and (pre|post)process data.
14
15How to compile a tool
16=====================
17
18The tool can be compiled using the maketools script in the tools directory as follows:
19
20.. code-block:: console
21
22   $ ./maketools -m 'my_arch' -n '<TOOL_NAME>'
23
24where ``my_arch`` can be selected among available architecture files or providing a user defined one.
25
26List of tools
27=============
28
29BDY_TOOLS
30---------
31
32It contains the utility *bdy_reorder* used to reorder old BDY data files used with
33previous versions of the model (before 3.4) to make them compatible with NEMO 3.4.
34
35DMP_TOOLS
36---------
37
38Used to create a netcdf file called :file:`resto.nc` containing
39restoration coefficients for use with the :file:`tra_dmp` module in NEMO
40(see :download:`DMP_TOOLS README <../../../tools/DMP_TOOLS/README>`).
41
42DOMAINcfg
43---------
44
45This tool allows the creation of a domain configuration file (``domain_cfg.nc``) containing
46the ocean domain information required to define an ocean configuration from scratch.
47(see :download:`DOMAINcfg README <../../../tools/DOMAINcfg/README>`).
48
49GRIDGEN
50-------
51
52A toolbox allowing the creation of regional configurations from curvilinear grid
53(see :download:`GRIDGEN documentation <../../../tools/GRIDGEN/doc_cfg_tools.pdf>`).
54
55MISCELLANEOUS
56-------------
57
58The tool allows to create alternative configurations to the community without
59having to rely on system team sponsorship and support.
60
61MPP_PREP
62--------
63
64This tool provides the user with information to choose the best domain decomposition.
65The tool computes the number of water processors for all possible decompositions,
66up to a maximum number of processors
67(see :download:`MPP_PREP documentation <../../../tools/MPP_PREP/mpp_nc.pdf>` and
68:download:`MPP_PREP archive <../../../tools/MPP_PREP/mpp_prep-1.0.tar.gz>`).
69
70NESTING
71-------
72
73AGRIF nesting tool allows for the seamless two-way coupling of nested sub-models within
74the NEMO framework as long as these are defined on subsets of the original root grid.
75It allows to create the grid coordinates, the surface forcing and the initial conditions required by
76each sub-model when running a NEMO/AGRIF embedded mode
77(see :download:`NESTING README <../../../tools/NESTING/README>`).
78
79OBSTOOLS
80--------
81
82A series of Fortran utilities which are helpful in handling observation files and
83the feedback file output from the NEMO observation operator.
84Further info are available in the :doc:`Nemo manual <cite>`.
85
86REBUILD_NEMO
87------------
88
89REBUILD_NEMO is a tool to rebuild NEMO output files from multiple processors
90(mesh_mask, restart or XIOS output files) into one file
91(see :download:`REBUILD_NEMO README <../../../tools/REBUILD_NEMO/README.rst>`).
92
93REBUILD
94-------
95
96It contains the old version of REBUILD_NEMO tool based on the IOIPSL code.
97
98SCOORD_GEN
99----------
100
101Offline tool to generate a vertical coordinates input file for use with S coordinates.
102This has been carried out by copying the model code to an offline tool and then
103modifying it to suppress the use of 3D arrays (to reduce memory usage).
104The tool has been created in preparation for the removal of the vertical grid definition from
105the code.
106The output file should contain all variables that are necessary to restart the model.
107
108SECTIONS_DIADCT
109---------------
110
111When the Transport across sections diagnostic is activated (``key_diadct``),
112this tool is used to build the binary file containing the pathways between
113the extremities of each section.
114Further info are available in the :doc:`Nemo manual <cite>`.
115
116SIREN
117-----
118
119SIREN is a configuration management tool to set up regional configurations with NEMO
120(see :download:`SIREN README <../../../tools/SIREN/README>`).
121
122WEIGHTS
123-------
124
125This directory contains software for generating and manipulating interpolation weights for use with
126the Interpolation On the Fly (IOF) option in NEMO v3 onwards
127(see :download:`WEIGHTS README <../../../tools/WEIGHTS/README>`).
128
129TOYATM
130------
131
132This directory contains a simplified model that send/receive atmospheric fields to/from NEMO.
133Used to test the coupling interface.
134This toy requires OASIS3-MCT to be installed and properly defined in the arch file.
Note: See TracBrowser for help on using the repository browser.