Brief documentation referencing web page

git-svn-id: http://svn.cactuscode.org/arrangements/CactusExternal/FlexIO/trunk@22 21a6bef8-4479-4f54-8f8d-0db94a2919ef

1 files changed, 106 insertions, 0 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
new file mode 100644
index 0000000..0c85eb5
--- /dev/null
+++ b/doc/documentation.tex
@@ -0,0 +1,106 @@
+\documentclass{article}
+
+\parskip = 2 pt
+\oddsidemargin = 0 cm
+\textwidth = 16 cm
+\topmargin = -1 cm
+\textheight = 24 cm
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% MANPAGE like description setting for options, use as 
+% \begin{Lentry} \item[text] text  \end{Lentry}
+
+\usepackage{ifthen,calc}
+
+\newcommand{\entrylabel}[1]{\mbox{\textsf{#1}}\hfil}
+\newenvironment{entry}
+  {\begin{list}{}
+    {\renewcommand{\makelabel}{\entrylabel}
+      \setlength{\labelwidth}{90pt}
+      \setlength{\leftmargin}{\labelwidth+\labelsep}
+    }
+  }
+  {\end{list}}
+
+\newlength{\Mylen}
+\newcommand{\Lentrylabel}[1]{%
+  \settowidth{\Mylen}{\textsf{#1}}%
+  \ifthenelse{\lengthtest{\Mylen > \labelwidth}}%
+    {\parbox[b]{\labelwidth} %  term > labelwidth
+      {\makebox[0pt][l]{\textsf{#1}}\\}} %
+    {\textsf{#1}} %
+
+  \hfil\relax}
+\newenvironment{Lentry}
+  {\renewcommand{\entrylabel}{\Lentrylabel}
+   \begin{entry}}
+  {\end{entry}}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{document}
+
+\title{FlexIO}
+\author{Thomas Radke, John Shalf}
+\date{September 2001}
+\maketitle
+
+\abstract{}
+
+\section{Purpose}
+
+Thorn FlexIO provides a library for writing multidimensional data from 
+Cactus using the IEEEIO data format. The advantage of using this library
+is that it is distributed with Cactus and needs no additional libraries
+to be installed on a machine.
+
+Writing in the FlexIO-IEEEIO format is currently implemented in thorn
+CactusPUGHIO/IOFlexIO.
+
+\section{FlexIO}
+
+FlexIO is a compact API for storing multidimensional scientific
+data. It hides the differences between underlying file formats
+including HDF-SDS, IEEEIO, and network socket connections. (Support
+for HDF5 will be added soon). It is designed to allow you to use
+exactly the same subroutine/method calls to store your data regardless
+of the underlying file format. FlexIO includes C++, C, and
+Fortran77/F90 interfaces and it has been ported to Sun-Solaris,
+Digital Unix, Cray-Unicos, SGI-Irix (32 and 64 bit), Windows95 and NT.
+
+FlexIO borrows its terminology and storage-style from HDF and
+NetCDF. The file stores a sequence of multidimesional arrays which are
+referred to generically as datasets. The dimensions and datatype are
+stored with each dataset so that the data is completely
+self-describing. In addition, NetCDF-style named attributes can be
+stored with each dataset to add information like coordinates, units,
+and other auxillary information.
+
+A set of higher level API's sit on top of FlexIO which permit
+simplified access to complex datastructures like Finite-Element,
+Adaptive Mesh Refinement, and Unigrid datastructures. In addition the
+MPIO interface provides access to parallel IO for MPI codes.
+
+\section{More Information}
+
+For more information the reader is directed to the web pages for 
+FlexIO at
+{\tt http://infinite-entropy.lbl.gov/FlexIO/}
+
+Information can be found on these web pages about
+
+\begin{itemize}
+
+  \item{} Programming interfaces, including C, C++ and Fortran
+ 
+  \item{} Utilities, for finding information about IEEEIO data files
+
+  \item{} Data converters, between IEEEIO and HDF
+
+\end{itemize}
+
+% Automatically created from the ccl files by using gmake thorndoc
+\include{interface}
+\include{param}
+\include{schedule}
+
+\end{document}