Very basic documentation, explaining the mode parameter which determines

whether or note jpeg images are advertised or not


git-svn-id: http://svn.cactuscode.org/arrangements/CactusIO/IOJpeg/trunk@55 eff87b29-5268-4891-90a3-a07138403961

1 files changed, 78 insertions, 0 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
new file mode 100644
index 0000000..2af0f93
--- /dev/null
+++ b/doc/documentation.tex
@@ -0,0 +1,78 @@
+\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{Boundary}
+\author{Gabrielle Allen, Thomas Radke}
+\date{2001}
+\maketitle
+
+\abstract{Output method using the jpeg format}
+
+\section{Use}
+
+Thorn IOJpeg provides 2D images from grid functions in jpeg format, these
+images are currently intended to be used for two purposes:
+
+\begin{itemize}
+
+\item{Monitoring from Web Server} Jpeg images can be directly visualised
+in the {\it viewport} provided by thorn {\tt CactusConnect/HTTPDExtra}. For 
+the images to be advertised to the Web Server the parameter {\tt iojpeg::mode = ``remove''} must be used.
+
+\item{Constructing Movies} A series of jpeg movies can easily
+ be used to construct a time series movie (e.g. using the Unix utilities
+{\tt convert} or {\tt xanim}). In this case the parameter {\tt iojpeg::mode = ``standard''} must be used.
+
+\end{itemize}
+
+Note that the parameter {\tt iojpeg::mode} determines whether a jpeg image is ccreated and kept for individual timesteps, or whether only the image from the current data is kept. Only in the second case is the jpeg file {\tt advertised} (otherwise there are potentially thousands of files advertised to e.g. the {\tt HTTPD} thorn). Also note that using the standard mode and creating jpegs every iteration can quite quickly lead to {\it inode} problems on a machine.
+
+We are planning to develop this thorn more to provide more features (eg 
+a range of 2D images from a 3D dataset, add possibility to save images for a movie and advertise current image).
+
+
+
+% Automatically created from the ccl files by using gmake thorndoc
+\include{interface}
+\include{param}
+\include{schedule}
+
+\end{document}