[cig-commits] r5554 - mc/3D/CitcomS/trunk/doc/manual

[luis at geodynamics.org]

Author: luis
Date: 2006-12-08 13:15:17 -0800 (Fri, 08 Dec 2006)
New Revision: 5554

Modified:
   mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx
Log:
Added MayaVi screenshot to manual, along with a couple of other fixes.


Modified: mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx
===================================================================
--- mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx	2006-12-08 20:41:04 UTC (rev 5553)
+++ mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx	2006-12-08 21:15:17 UTC (rev 5554)
@@ -1,4 +1,4 @@
-#LyX 1.4.3 created this file. For more info see http://www.lyx.org/
+#LyX 1.4.1 created this file. For more info see http://www.lyx.org/
 \lyxformat 245
 \begin_document
 \begin_header
@@ -4521,8 +4521,8 @@
 \end_layout
 
 \begin_layout Standard
-HDF (Hierarchical Data Format) is a portable file format and software developed
- at the 
+The Hierarchical Data Format (HDF) is a portable file format developed at
+ the 
 \begin_inset LatexCommand \htmlurl[National Center for Supercomputing Applications (NCSA)]{hdf.ncsa.uiuc.edu/HDF5}
 
 \end_inset
@@ -5703,8 +5703,8 @@
 \end_inset
 
 .
- An experimental script for MayaVi2 visualization is provided; see Section
- 
+ We provide experimental scripts for a 3D visualization program called MayaVi2;
+ see Section 
 \begin_inset LatexCommand \vref{sec:Using-MayaVi-for}
 
 \end_inset
@@ -6594,7 +6594,7 @@
 \begin_layout Standard
 MayaVi2 is the successor of MayaVi for 2D/3D scientific data visualization.
  It is an interactive program allowing elaborate plots of scientific data.
- MayaVi2 relies on the vtk visualisation toolkit and allows easy scripting
+ MayaVi2 relies on the Visualization Toolkit (VTK) and allows easy scripting
  in Python.
  To install MayaVi2, you should follow the instructions on the 
 \begin_inset LatexCommand \htmlurl[MayaVi2 website]{https://svn.enthought.com/enthought/wiki/GrabbingAndBuilding}
@@ -6607,12 +6607,72 @@
 \end_inset
 
 .
+ You should also follow the instructions provided under 
+\family typewriter
+PATH/visual/Mayavi2/README
+\family default
+ (TODO: how to refer to this path?) in order to visualize CitComS HDF5 timestep
+ files.
 \end_layout
 
 \begin_layout Standard
+Once you have opened a CitComS timestep file, you may adjust your visualization
+ pipeline by adding any appropriate VTK filters and modules.
+ For more details about this process, refer to 
+\shape italic
+\size small
+The Visualization Toolkit User's Guide
+\shape default
+\size default
+ (ISBN 1-930934-13-0) or to the 
+\begin_inset LatexCommand \url[VTK website]{www.vtk.org}
 
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+\begin_inset Float figure
+wide false
+sideways false
+status open
+
+\begin_layout Standard
+\begin_inset Graphics
+	filename graphics/mayavi2.png
+	lyxscale 90
+	scale 90
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Caption
+Example MayaVi visualization of 
+\family typewriter
+\size small
+cookbook1.100.h5
+\family default
+\size default
+.
+ Here, we display the temperature field from caps 1 thru 6, as well as the
+ velocity field from cap 7.
+ Note the visualization pipeline in the tree view on the left.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+(
 \series bold
-TODO: MayaVi Scripts
+TODO
+\series default
+: finish mayavi section)
 \end_layout
 
 \begin_layout Section
@@ -6767,7 +6827,7 @@
 \end_layout
 
 \begin_layout Standard
-The script will ask you a few question on how to specify the great circle
+The script will ask you a few questions on how to specify the great circle
  path.
  There are three options: 1) a starting point and an azimuth, 2) a starting
  point and another point on the great circle, and 3) a starting point and