source: utils/tools/README.rst

Last change on this file was 13246, checked in by clevy, 5 months ago

Update rst files

File size: 4.8 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---------
44A toolbox allowing the creation of regional configurations from curvilinear grid
45(see :download:`DOMAINcfg README <../../../tools/DOMAINcfg/README.rst>`).
46
47GRIDGEN
48-------
49This tool allows the creation of a domain configuration file (``domain_cfg.nc``) containing
50the ocean domain information required to define an ocean configuration from scratch.
51(see :download:`GRIDGEN documentation <../../../tools/GRIDGEN/doc_cfg_tools.pdf>`).
52
53MISCELLANEOUS
54-------------
55
56The tool allows to create alternative configurations to the community without
57having to rely on system team sponsorship and support.
58
59MPP_PREP
60--------
61
62This tool provides the user with information to choose the best domain decomposition.
63The tool computes the number of water processors for all possible decompositions,
64up to a maximum number of processors
65(see :download:`MPP_PREP documentation <../../../tools/MPP_PREP/mpp_nc.pdf>` and
66:download:`MPP_PREP archive <../../../tools/MPP_PREP/mpp_prep-1.0.tar.gz>`).
67
68NESTING
69-------
70
71AGRIF nesting tool allows for the seamless two-way coupling of nested sub-models within
72the NEMO framework as long as these are defined on subsets of the original root grid.
73It allows to create the grid coordinates, the surface forcing and the initial conditions required by
74each sub-model when running a NEMO/AGRIF embedded mode
75(see :download:`NESTING README <../../../tools/NESTING/README>`).
76
77OBSTOOLS
78--------
79
80A series of Fortran utilities which are helpful in handling observation files and
81the feedback file output from the NEMO observation operator.
82Further info are available in the :doc:`Nemo manual <cite>`.
83
84REBUILD_NEMO
85------------
86
87REBUILD_NEMO is a tool to rebuild NEMO output files from multiple processors
88(mesh_mask, restart or XIOS output files) into one file
89(see :download:`REBUILD_NEMO README <../../../tools/REBUILD_NEMO/README.rst>`).
90
91REBUILD
92-------
93
94It contains the old version of REBUILD_NEMO tool based on the IOIPSL code.
95
96SCOORD_GEN
97----------
98
99Offline tool to generate a vertical coordinates input file for use with S coordinates.
100This has been carried out by copying the model code to an offline tool and then
101modifying it to suppress the use of 3D arrays (to reduce memory usage).
102The tool has been created in preparation for the removal of the vertical grid definition from
103the code.
104The output file should contain all variables that are necessary to restart the model.
105
106SECTIONS_DIADCT
107---------------
108
109When the Transport across sections diagnostic is activated (``key_diadct``),
110this tool is used to build the binary file containing the pathways between
111the extremities of each section.
112Further info are available in the :doc:`Nemo manual <cite>`.
113
114SIREN
115-----
116
117SIREN is a configuration management tool to set up regional configurations with NEMO
118(see :download:`SIREN README <../../../tools/SIREN/README>`).
119
120WEIGHTS
121-------
122
123This directory contains software for generating and manipulating interpolation weights for use with
124the Interpolation On the Fly (IOF) option in NEMO v3 onwards
125(see :download:`WEIGHTS README <../../../tools/WEIGHTS/README>`).
126
127TOYATM
128------
129
130This directory contains a simplified model that send/receive atmospheric fields to/from NEMO, for use in the CPL_OASIS sed to test case of the NEMO-OASIS coupling interface.
131This toy requires OASIS3-MCT to be installed and properly defined in the arch file.
132(see :download:`CPL_OASIS README <../../../tests/CPL_OASIS/README.md>`).
133
134ABL_TOOLS
135---------
136
1373 steps to generate atmospheric forcings from ECMWF products for ABL1d model with NEMO:
138- main_uvg_hpg (optional): geostrophic wind or horizontal pressure gradient computation on ECMWF eta-levels (to force ABL dynamics)
139- main_vinterp: vertical interpolation from ECWMF vertical eta-levels to ABL Z-levels
140- main_hdrown: 3D-fields horizontal drowning (extrapolation over land totally inspired from SOSIE by L. Brodeau)
141(more details available in Lemarie et al. 2020 GMD)
Note: See TracBrowser for help on using the repository browser.