Philippe 02/05/2016: moved all LIBTOOLS files in LIBTOOLS directory
[MNH-git_open_source-lfs.git] / LIBTOOLS / readme / LATEX / lfi2cdf.tex
1 \section{Conversion to NetCDF files}
2
3 \subsection{{\tt lfi2cdf} tool}
4
5 The \texttt{lfi2cdf} tool converts the binary part (or LFI file) of a
6 FM file (synchronous or diachronic) into a NetCDF file.  All the fields
7 (or more precisely all the LFI articles) contained in the input LFI file
8 are copied to the NetCDF output file with their values unchanged. As
9 a LFI article does not hold any information on the variable, the tool
10 tries to describe the corresponding NetCDF variable by using~:
11
12 \begin{itemize}
13 \item 3 LFI articles: \texttt{IMAX, JMAX,} and \texttt{KMAX}
14   if they are available in the LFI input file. These articles may
15   provide the NetCDF dimensions \texttt{DIMX, DIMY,} and \texttt{DIMZ}
16   of an array variable. If these variables are not available in the
17   input file, the tool treats each array variable as a 1D array.
18 \item a small database implemented as a structure array in the
19   \texttt{lfi2cdf} source file \texttt{fieldtype.f90}. This array
20   holds the type (\texttt{REAL, INTEGER, LOGICAL}\ldots) of every
21   common LFI article. When an article is not present in this database,
22   its name is displayed on \texttt{stdout} by the running tool, and
23   the corresponding values are always considered as \texttt{REAL}
24   values. A new LFI article type description can be easily added in
25   the \texttt{fieldtype.f90} source file and the tool must be then
26   recompiled.
27 \end{itemize}
28
29 \subsubsection{Usage}
30 The binary part of the FM file is required in the current directory.
31 The following commands convert a file \texttt{myfile.lfi} from LFI to NetCDF:
32
33 \begin{verbatim}
34 lfi2cdf myfile.lfi
35 \end{verbatim} 
36 or
37 \begin{verbatim}
38 lfi2cdf myfile
39 \end{verbatim}
40
41 \noindent The output NetCDF file is named:
42 \texttt{myfile.cdf}. 
43 %myfile{\bf .cdf}. 
44 It can easily be manipulated by NetCDF tools\footnote{see
45 freely available NetCDF software at  http://www.unidata.ucar.edu/packages/netcdf/software.html} like
46 \texttt{ncdump}, \texttt{ncview}, or \texttt{NCO} operators.\\
47
48 \noindent In the same way, you will convert a NetCDF
49 file \texttt{myfile.cdf} back to LFI format by typing:
50
51 \begin{verbatim}
52 cdf2lfi myfile.cdf
53 \end{verbatim}
54 or
55 \begin{verbatim}
56 cdf2lfi myfile
57 \end{verbatim}
58 The output LFI file is then named: \texttt{myfile.lfi}
59
60
61 \subsection{{\tt extractdia} tool}
62 The \texttt{extractdia} tool converts a diachronic FM file into a NetCDF file after an extraction of a list of fields and an optional extraction of a sub-domain.  See the section \ref{extractdia}.
63
64
65 %%% Local Variables: 
66 %%% mode: latex
67 %%% TeX-master: "tools"
68 %%% End: