diff options
| -rw-r--r-- | doc/documentation.tex | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index cb6b806..194c1ab 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -160,7 +160,7 @@ it would probably not make much sense to feed this datafile into Cactus for initializing your x coordinate grid function :-) % % -\subsection{Other utility programs in IOFlexIO} +\subsection{Other utility programs in IOHDF5} % In addition to the HDF5 recombiner program, thorn IOHDF5 also provides some other utilities which can be build the same way: @@ -168,8 +168,24 @@ some other utilities which can be build the same way: \begin{itemize} \item {\tt hdf5\_convert\_from\_ieeeio.c}\\ Converts a datafile created by thorn IOFlexIO into an HDF5 datafile. + \item {\tt hdf5\_merge.c}\\ + Merges a list of HDF5 input files into a single HDF5 output file. + This can be used to concatenate HDF5 output data created as one file per + timestep. + \item {\tt hdf5\_extract.c}\\ + Extracts a given list of named objects (groups or datasets) from an HDF5 + input file and writes them into a new HDF5 output file. + This is the reverse operation to what {\tt hdf5\_merge.c} does. Useful eg. + for extracting individual timesteps from a time series HDF5 datafile. + \item {\tt hdf5\_bitant\_to\_fullmode.c}\\ + Converts all datasets in a given HDF5 file from bitant into full mode data. + This is accomplished by reflecting the data in z-direction with a given + stencil width. \end{itemize} % +All utility programs are self-explaining -- just call them without arguments +to get a short usage info. +% If any of these utility programs is called without arguments it will print a usage message. % |