CarpetIOHDF5: document utility programs for CarpetIOHDF5 data processing

darcs-hash:20060808143907-776a0-965984d0fe8688c51fe0a5d9bf8d1dfd51a3eb8a.gz

1 files changed, 32 insertions, 0 deletions

diff --git a/Carpet/CarpetIOHDF5/doc/documentation.tex b/Carpet/CarpetIOHDF5/doc/documentation.tex
index 32993385d..11042547d 100644
--- a/Carpet/CarpetIOHDF5/doc/documentation.tex
+++ b/Carpet/CarpetIOHDF5/doc/documentation.tex
@@ -36,6 +36,8 @@ of the HDF5 file format that was adapted from John Shalf's FlexIO library.
 \end{abstract}
 
 
+\tableofcontents
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \section{Introduction}
 
@@ -224,6 +226,36 @@ parameters of thorn {\bf IOUtil} (for a description of these parameters please
 refer to this thorn's documentation).
 
 
+\section{CarpetIOHDF5 Utility Programs}
+
+\subsection{{\tt hdf5toascii\_slicer}}
+
+This utility program extracts 2D slices from 3D HDF5
+datasets produced by \ThisThorn\ and outputs them in {\tt CarpetIOASCII} format
+(suitable to be further processed by gnuplot).
+
+The {\tt hdf5toascci\_slicer} program is contained in the {\tt src/utils/}
+subdirectory of thorn \ThisThorn. It is built with
+\begin{verbatim}
+  make <configuration>-utils
+\end{verbatim}
+where the executable ends up in the subdirectory {\tt exe/<configuration>/}.
+
+\subsection{{\tt hdf5\_extract}}
+
+This utility program extracts selected datasets from any given HDF5 output file
+which may be useful when only certain parts (eg. a specific
+timestep) of large files are required (eg. for copying to some other
+location for further processing).
+
+The {\tt hdf5\_extract} program is contained in the {\tt src/utils/}
+subdirectory of thorn {\tt CactusPUGHIO/IOHDF5}. It is built with
+\begin{verbatim}
+  make <configuration>-utils
+\end{verbatim}
+where the executable ends up in the subdirectory {\tt exe/<configuration>/}.
+
+
 \section{Example Parameter File Excerpts}
 
 \subsection{Serial (unchunked) Output of Grid Variables}