Parameter names changes as announced in today's mail to users@cactuscode.org.

You must also update thorn IOUtil now.

This thorn will be moved from BetaThorns to CactusPUGHIO now.


git-svn-id: http://svn.cactuscode.org/arrangements/CactusPUGHIO/IOHDF5Util/trunk@64 7842ec3a-9562-4be5-9c5b-06ba18f2b668

1 files changed, 46 insertions, 0 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
new file mode 100644
index 0000000..6a621e1
--- /dev/null
+++ b/doc/documentation.tex
@@ -0,0 +1,46 @@
+% Thorn documentation template
+\documentclass{article}
+\begin{document}
+
+\title{IOHDF5Util}
+\author{Thomas Radke}
+\date{2000\\$ $Revision$ $Date$ $}
+\maketitle
+
+\abstract{
+Thorn {\bf IOHDF5Util} provides functionality to implement HDF5 I/O in Cactus.
+}
+
+\section{Purpose}
+Thorn {\bf IOHDF5Util} provides common routines which can be used to implement
+Cactus I/O methods for input/output of Cactus variables in the HDF5 standard
+(Hierarchical Data Format Version 5).
+
+Currently, {\bf IOHDF5Util} is inherited by the {\bf IOHDF5} and
+{\bf IOStreamHDF5} I/O thorns which share its routines to implement their own
+I/O methods doing parallel HDF5 file I/O and online HDF5 data streaming.
+%
+%
+\section{Building A Cactus Configuration with {\bf IOHDF5Util}}
+%
+The Cactus distribution does not contain the HDF5 header files and library which
+is used by thorn {\bf IOHDF5Util}. So you need to configure it as an external
+software package via:
+%
+\begin{verbatim}
+  make <configuration>-config HDF5=yes
+                             [HDF5_DIR=<path to HDF5 package>]
+\end{verbatim}
+%
+The configuration script will look in some default places for an installed
+HDF5 package. If nothing is found this way you can explicitly specify it with
+the {\tt HDF5\_DIR} configure variable.
+
+%
+% Automatically created from the ccl files
+% Do not worry for now.
+\include{interface}
+\include{param}
+\include{schedule}
+
+\end{document}