source: utils/tools/README.rst @ 11736

Last change on this file since 11736 was 11736, checked in by nicolasmartin, 13 months ago

Remaining modified files

File size: 4.4 KB
Line 
1*****
2Tools
3*****
4
5.. todo::
6
7
8
9.. contents::
10   :local:
11
12A set of tools is provided with NEMO to setup user own configuration and (pre|post)process data.
13
14**How to compile a tool**
15
16The tool can be compiled using the maketools script in the tools directory as follows:
17
18.. code-block:: console
19
20        $ ./maketools -m '$ARCH' -n '<TOOL_NAME>'
21
22where ``$ARCH`` can be selected among available architecture files or providing a user defined one.
23
24BDY_TOOLS
25---------
26
27It contains the utility *bdy_reorder* used to reorder old BDY data files used with previous versions of the model (before 3.4) to make them compatible with NEMO 3.4.
28
29DMP_TOOLS
30---------
31
32Used 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>`_).
33
34DOMAINcfg
35---------
36
37This 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>`_).
38
39GRIDGEN
40-------
41
42A 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>`_ ).
43
44MISCELLANEOUS
45-------------
46
47The tool allows to create alternative configurations to the community without having to rely on system team sponsorship and support.
48
49MPP_PREP
50--------
51
52This tool provides the user with information to choose the best domain decomposition.
53The tool computes the number of water processors for all possible decompositions (up to a maximum number of processors).
54Documentation: `mpp_nc.pdf <http://forge.ipsl.jussieu.fr/nemo/attachment/wiki/Users/SetupNewConfiguration/mpp_nc.pdf>`_
55Tar file     : `mpp_prep-1.0.tar.gz <http://forge.ipsl.jussieu.fr/nemo/attachment/wiki/Users/SetupNewConfiguration/mpp_prep-1.0.tar.gz>`_
56
57NESTING
58-------
59
60AGRIF 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.
61It 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>`_).
62
63OBSTOOLS
64--------
65
66A series of Fortran utilities which are helpful in handling observation files and the feedback file output from the NEMO observation operator.
67Further info are available in the Nemo manual.
68
69REBUILD_NEMO
70------------
71
72REBUILD_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>`_).
73
74REBUILD
75-------
76
77It contains the old version of REBUILD_NEMO tool based on the IOIPSL code.
78
79SCOORD_GEN
80----------
81
82Offline 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.
83
84SECTIONS_DIADCT
85---------------
86
87When 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.
88Further info are available in the Nemo manual.
89
90SIREN
91-----
92
93SIREN 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>`_)
94
95WEIGHTS
96-------
97
98This 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>`_)
99
100TOYATM
101------
102
103This directory contains a simplified model that send/receive atmospheric fields to/from NEMO. Used to test the coupling interface. This toy requires OASIS3-MCT to be installed and properly defined in the arch file.
Note: See TracBrowser for help on using the repository browser.