[cig-commits] r5562 - in mc/3D/CitcomS/trunk/doc/manual: . graphics

[tan2 at geodynamics.org]

Author: tan2
Date: 2006-12-08 15:36:57 -0800 (Fri, 08 Dec 2006)
New Revision: 5562

Modified:
   mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx
   mc/3D/CitcomS/trunk/doc/manual/graphics/mayavi2.png
Log:
Updated MayaVi2 section

Modified: mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx
===================================================================
--- mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx	2006-12-08 23:30:39 UTC (rev 5561)
+++ mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx	2006-12-08 23:36:57 UTC (rev 5562)
@@ -1,4 +1,4 @@
-#LyX 1.4.3 created this file. For more info see http://www.lyx.org/
+#LyX 1.4.2 created this file. For more info see http://www.lyx.org/
 \lyxformat 245
 \begin_document
 \begin_header
@@ -2596,6 +2596,10 @@
 \end_layout
 
 \begin_layout Subsubsection
+\begin_inset LatexCommand \label{sub:PyTables}
+
+\end_inset
+
 PyTables
 \end_layout
 
@@ -6607,17 +6611,60 @@
 \end_inset
 
 .
- You should also follow the instructions provided under 
+ Besides MayaVi2, you will need to install PyTables (see Section 
+\begin_inset LatexCommand \vref{sub:PyTables}
+
+\end_inset
+
+) and PyVTK (see 
+\begin_inset LatexCommand \htmlurl[PyVTK website]{http://cens.ioc.ee/projects/pyvtk/}
+
+\end_inset
+
+ for instruction) before using the script.
+\end_layout
+
+\begin_layout Standard
+The script acts as an extension module of MayaVi2.
+ The installation of the script is still preliminary.
+ You will need to include 
 \family typewriter
-PATH/visual/Mayavi2/README
+PREFIX/share/CitcomS/visual/Mayavi2/citcoms_plugins/
 \family default
- (TODO: how to refer to this path?) in order to visualize CitComS HDF5 timestep
- files.
+ in your 
+\family typewriter
+PYTHONPATH
+\family default
+ environment variable.
+ You also need to create a directory called 
+\family typewriter
+~/.mayavi2
+\family default
+ and copy 
+\family typewriter
+PREFIX/share/CitcomS/visual/Mayavi2/mayavi_custom_ui.py
+\family default
+ into it.
 \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.
+To run the script, type this command:
+\end_layout
+
+\begin_layout LyX-Code
+$ mayavi2_citcoms_display.py 
+\shape italic
+file.step.h5
+\end_layout
+
+\begin_layout Standard
+This will launch MayaVi2 and load the data from 
+\family typewriter
+file.step.h5
+\family default
+.
+ You may adjust your visualization pipeline by adding any appropriate VTK
+ filters and modules.
  For more details about this process, refer to 
 \shape italic
 The Visualization Toolkit User's Guide
@@ -6644,8 +6691,8 @@
 \align center
 \begin_inset Graphics
 	filename graphics/mayavi2.png
-	lyxscale 44
-	scale 44
+	lyxscale 40
+	scale 40
 
 \end_inset
 
@@ -6653,16 +6700,16 @@
 \end_layout
 
 \begin_layout Caption
-Example MayaVi visualization of 
+Example MayaVi2 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.
+ Here we display the velocity field as vectors, as well a slice of the temperatu
+re field.
+ Note the visualization pipeline in the tree view on the left panel.
 \end_layout
 
 \end_inset
@@ -6670,14 +6717,6 @@
 
 \end_layout
 
-\begin_layout Standard
-(
-\series bold
-TODO
-\series default
-: finish mayavi section)
-\end_layout
-
 \begin_layout Section
 \begin_inset LatexCommand \label{sec:Using-GMT-Commands}
 

Modified: mc/3D/CitcomS/trunk/doc/manual/graphics/mayavi2.png
===================================================================
(Binary files differ)