Welcome to TNT’s documentation (TheNamelistTool)!¶
TNT stands for “The Namelist Tool”.
The main objectives of this package is to provide command line tools useful to work with namelists or pack of namelists (update them, compare them, …).
The Sphinx documentation of this package is few. However, for end users, the
entry points to this package are the tnt.py, tntdiff.py and
tntstack.py command line utilities provided in the tools subdirectory
(or in your $PATH when pip is used).
These command line utility are provided with an embedded documentation accessible
with the -h option (e.g. tnt.py -h).
The tnt.py and tntstack.py command line utilities heavily rely on
directive files. A template of such directive files can be generated using the
-D option (tnt.py -D or tntstack.py -D). The template directives
files are thoroughly documented and should be regarded as documentation.
Developpers’ corner¶
Here is a list sub-modules/packages:
A bunch of classes and functions that deal with TNT configuration files and directives. |
|
Adapter classes for namelist's parsers. |
|
Utility methods widely used in the various TNT utilities. |
|
A collection of "main" subroutine to start various command-line tools. |