Changeset 7313

Timestamp:

Jul 20, 2009, 4:29:29 PM (15 years ago)

Author:

ole

Message:

Updated manual with rudimentary reference to new viewer.

File:

• anuga_core/documentation/user_manual/anuga_user_manual.tex (modified) (2 diffs)

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -629 +629 @@
 The output is a NetCDF file with the extension \code{.sww}. It
 contains stage and momentum information and can be used with the
-\anuga viewer \code{animate} to generate a visual
+\anuga viewer \code{anuga\_viewer} to generate a visual
 display (see Section \ref{sec:animate}). See Section \ref{sec:file formats}
 (page \pageref{sec:file formats}) for more on NetCDF and other file
@@ -3941 +3941 @@
 
 
+
 \pagebreak
-\section{\anuga viewer -- animate}
+\section{anuga\_viewer}
 \label{sec:animate}
 
 The output generated by \anuga may be viewed by
-means of the visualisation tool \code{animate}, which takes an
+means of the visualisation tool \code{anuga\_viewer}, which takes an
 SWW file generated by \anuga and creates a visual representation
 of the data. Examples may be seen in Figures \ref{fig:runupstart}
 and \ref{fig:runup2}. To view an SWW file with
-\code{animate} in the Windows environment, you can simply drag the
-icon representing the file over an icon on the desktop for the
-\code{animate} executable file (or a shortcut to it), or set up a
-file association to make files with the extension \code{.sww} open
-with \code{animate}. Alternatively, you can operate \code{animate}
-from the command line.
-
-Upon starting the viewer, you will see an interactive moving-picture
-display. You can use the keyboard and mouse to slow down, speed up or
-stop the display, change the viewing position or carry out a number
-of other simple operations. Help is also displayed when you press
-the \code{h} key.
-
-The main keys operating the interactive screen are:
-\begin{center}
-\begin{tabular}{|ll|}   \hline
-  \code{h} & toggle on-screen help display \\
-  \code{w} & toggle wireframe \\
-  space bar & start/stop\\
-  up/down arrows & increase/decrease speed\\
-  left/right arrows & direction in time \emph{(when running)}\\
-                    & step through simulation \emph{(when stopped)}\\
-  left mouse button & rotate\\
-  middle mouse button & pan\\
-  right mouse button & zoom\\  \hline
-\end{tabular}
-\end{center}
-
-% \vfill
-
-The following describes how to operate \code{animate} from the command line:
-
-Usage: \code{animate [options] swwfile \ldots}\\ \nopagebreak
-where: \\ \nopagebreak
-\begin{tabular}{ll}
-  \code{--display <type>} & \code{MONITOR | POWERWALL | REALITY\_CENTER |}\\
-                                    & \code{HEAD\_MOUNTED\_DISPLAY}\\
-  \code{--rgba} & Request a RGBA colour buffer visual\\
-  \code{--stencil} & Request a stencil buffer visual\\
-  \code{--stereo} & Use default stereo mode which is \code{ANAGLYPHIC} if not \\
-                                    & overridden by environmental variable\\
-  \code{--stereo <mode>} & \code{ANAGLYPHIC | QUAD\_BUFFER | HORIZONTAL\_SPLIT |}\\
-                                    & \code{VERTICAL\_SPLIT | LEFT\_EYE | RIGHT\_EYE |}\\
-                                     & \code{ON | OFF} \\
-  \code{-alphamax <float 0-1>} & Maximum transparency clamp value\\
-  \code{-alphamin <float 0-1>} & Transparency value at \code{hmin}\\
-  \code{-cullangle <float angle 0-90>} & Cull triangles steeper than this value\\
-  \code{-help} & Display this information\\
-  \code{-hmax <float>} & Height above which transparency is set to
-                                     \code{alphamax}\\
-  \code{-hmin <float>} & Height below which transparency is set to
-                                     zero\\
-  \code{-lightpos <float>,<float>,<float>} & $x,y,z$ of bedslope directional light ($z$ is
-                                     up, default is overhead)\\
-  \code{-loop}  & Repeated (looped) playback of \code{.swm} files\\
-  \code{-movie <dirname>} & Save numbered images to named directory and
-                                     quit\\
-  \code{-nosky} & Omit background sky\\
-  \code{-scale <float>} & Vertical scale factor\\
-  \code{-texture <file>} & Image to use for bedslope topography\\
-  \code{-tps <rate>} & Timesteps per second\\
-  \code{-version} & Revision number and creation (not compile)
-                                     date\\
-\end{tabular}
+\code{anuga\_viewer} in the Windows environment you have to run it in a command line as in
+\begin{verbatim}
+anuga_viewer <swwfile>
+\end{verbatim} 
+
+or if a georeferenced tif file (or jpg cut to the same shape as the domain) is needed
+
+\begin{verbatim} 
+anuga_viewer <swwfile> <tif file>
+\end{verbatim} 
+
+%, you can simply drag the
+%icon representing the file over an icon on the desktop for the
+%\code{anuga\_viewer} executable file (or a shortcut to it), or set up a
+%file association to make files with the extension \code{.sww} open
+%with \code{animate}. Alternatively, you can operate \code{animate}
+%from the command line.
+
+
+
+
+%% \pagebreak
+%% \section{\anuga viewer -- animate}
+%% \label{sec:animate}
+
+%% The output generated by \anuga may be viewed by
+%% means of the visualisation tool \code{animate}, which takes an
+%% SWW file generated by \anuga and creates a visual representation
+%% of the data. Examples may be seen in Figures \ref{fig:runupstart}
+%% and \ref{fig:runup2}. To view an SWW file with
+%% \code{animate} in the Windows environment, you can simply drag the
+%% icon representing the file over an icon on the desktop for the
+%% \code{animate} executable file (or a shortcut to it), or set up a
+%% file association to make files with the extension \code{.sww} open
+%% with \code{animate}. Alternatively, you can operate \code{animate}
+%% from the command line.
+
+%% Upon starting the viewer, you will see an interactive moving-picture
+%% display. You can use the keyboard and mouse to slow down, speed up or
+%% stop the display, change the viewing position or carry out a number
+%% of other simple operations. Help is also displayed when you press
+%% the \code{h} key.
+
+%% The main keys operating the interactive screen are:
+%% \begin{center}
+%% \begin{tabular}{|ll|}   \hline
+%%   \code{h} & toggle on-screen help display \\
+%%   \code{w} & toggle wireframe \\
+%%   space bar & start/stop\\
+%%   up/down arrows & increase/decrease speed\\
+%%   left/right arrows & direction in time \emph{(when running)}\\
+%%                     & step through simulation \emph{(when stopped)}\\
+%%   left mouse button & rotate\\
+%%   middle mouse button & pan\\
+%%   right mouse button & zoom\\  \hline
+%% \end{tabular}
+%% \end{center}
+
+%% % \vfill
+
+%% The following describes how to operate \code{animate} from the command line:
+
+%% Usage: \code{animate [options] swwfile \ldots}\\ \nopagebreak
+%% where: \\ \nopagebreak
+%% \begin{tabular}{ll}
+%%   \code{--display <type>} & \code{MONITOR | POWERWALL | REALITY\_CENTER |}\\
+%%                                     & \code{HEAD\_MOUNTED\_DISPLAY}\\
+%%   \code{--rgba} & Request a RGBA colour buffer visual\\
+%%   \code{--stencil} & Request a stencil buffer visual\\
+%%   \code{--stereo} & Use default stereo mode which is \code{ANAGLYPHIC} if not \\
+%%                                     & overridden by environmental variable\\
+%%   \code{--stereo <mode>} & \code{ANAGLYPHIC | QUAD\_BUFFER | HORIZONTAL\_SPLIT |}\\
+%%                                     & \code{VERTICAL\_SPLIT | LEFT\_EYE | RIGHT\_EYE |}\\
+%%                                      & \code{ON | OFF} \\
+%%   \code{-alphamax <float 0-1>} & Maximum transparency clamp value\\
+%%   \code{-alphamin <float 0-1>} & Transparency value at \code{hmin}\\
+%%   \code{-cullangle <float angle 0-90>} & Cull triangles steeper than this value\\
+%%   \code{-help} & Display this information\\
+%%   \code{-hmax <float>} & Height above which transparency is set to
+%%                                      \code{alphamax}\\
+%%   \code{-hmin <float>} & Height below which transparency is set to
+%%                                      zero\\
+%%   \code{-lightpos <float>,<float>,<float>} & $x,y,z$ of bedslope directional light ($z$ is
+%%                                      up, default is overhead)\\
+%%   \code{-loop}  & Repeated (looped) playback of \code{.swm} files\\
+%%   \code{-movie <dirname>} & Save numbered images to named directory and
+%%                                      quit\\
+%%   \code{-nosky} & Omit background sky\\
+%%   \code{-scale <float>} & Vertical scale factor\\
+%%   \code{-texture <file>} & Image to use for bedslope topography\\
+%%   \code{-tps <rate>} & Timesteps per second\\
+%%   \code{-version} & Revision number and creation (not compile)
+%%                                      date\\
+%% \end{tabular}