source: utils/tools/README.rst @ 10619

Last change on this file since 10619 was 10619, checked in by smasson, 21 months ago

trunk: add TOYATM in tools

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