[cig-commits] r13908 - doc/cigma/manual

[luis at geodynamics.org]

Author: luis
Date: 2009-01-21 11:38:07 -0800 (Wed, 21 Jan 2009)
New Revision: 13908

Added:
   doc/cigma/manual/checklist.txt
Modified:
   doc/cigma/manual/main.lyx
Log:
Update main.lyx and transfer checklist from old cigma.lyx into a text file.

Added: doc/cigma/manual/checklist.txt
===================================================================
--- doc/cigma/manual/checklist.txt	                        (rev 0)
+++ doc/cigma/manual/checklist.txt	2009-01-21 19:38:07 UTC (rev 13908)
@@ -0,0 +1,42 @@
+
+Verify that the following points are discussed in the manual:
+
+  - Cigma does not include a mesh generation package, so in order
+    to have greater accuracy in the comparisons one needs to increase
+    order of the integration rule being used.
+
+  - Meshes are internally stored as unstructured meshes.
+
+  - That we can only compare Fields on a single ElementBlock at a time.
+
+Things to check for the release:
+
+  - Files
+    * Make sure the tarball has all the required files
+    * Check for the proper /doc/ files
+    * Check for the proper /examples/ files
+    * Check that all required data files are included (see /tests/data/ directory)
+    * Check that 'make check' works
+
+  - Installation procedures
+    * Create tarball with 'make dist' and test it
+    * Use custom boost installation on ~/opt/boost
+    * Use custom hdf5 installation on ~/opt/hdf5
+    * Use custom vtk installation on ~/opt/vtk
+
+  - Consistency checks
+    * comparing one and zero on brick{1,2} meshes (should give volume)
+    * comparing test.brick and zero on brick{1,2} meshes (should give known answer)
+    * comparing test.square and zero on brick{1,2} meshes (should give known answer)
+
+  - Integration rules
+    * Increase order of integration rule instead of mesh refinement (check convergence)
+
+  - Examples
+    * comparing laplace solutions
+    * comparing citcomcu solutions
+    * comparing conman solutions (see blankenbach)
+    * comparing gale solutions
+    * comparing pylith solutions
+    * comparing geofest solutions
+

Modified: doc/cigma/manual/main.lyx
===================================================================
--- doc/cigma/manual/main.lyx	2009-01-21 19:38:06 UTC (rev 13907)
+++ doc/cigma/manual/main.lyx	2009-01-21 19:38:07 UTC (rev 13908)
@@ -835,11 +835,10 @@
 \end_layout
 
 \begin_layout Standard
-The basic object used to store data in Cigma is a simple two dimensional
- array of values, or dataset.
- Since scientific file formats are capable of storing multiple datasets,
- you will typically need a way to select a specific array on a given data
- file.
+The basic objects used to store data in Cigma are simple two dimensional
+ array of values, or datasets.
+ As scientific file formats are capable of storing multiple datasets, you
+ will typically need a way to select a specific array on a given data file.
  Therefore, regardless of the context, the option arguments to Cigma are
  parsed consistently by following the 
 \family typewriter
@@ -852,11 +851,11 @@
 \emph on
 filename
 \emph default
- unambiguously determines the target array, then the 
+ part unambiguously determines the target array, then the 
 \emph on
 location
 \emph default
- part of the option argument is taken to be empty.
+ part of the option argument may be omitted.
  Now, depending on how Cigma was configured during the build procedure,
  there are a number of different file formats available for specifying and
  storing your data.
@@ -1224,7 +1223,7 @@
 \end_layout
 
 \begin_layout Subsection
-Mesh from an HDF5 File
+Mesh HDF5 File
 \end_layout
 
 \begin_layout Standard
@@ -1280,20 +1279,32 @@
 \end_layout
 
 \begin_layout LyX-Code
- |-- Attribute 
+ |-- 
+\emph on
+Attribute
+\emph default
+ 
 \series bold
 \emph on
 CellType
 \end_layout
 
 \begin_layout LyX-Code
- |-- Array 
+ |-- 
+\emph on
+Array
+\emph default
+ 
 \series bold
 coordinates
 \end_layout
 
 \begin_layout LyX-Code
- `-- Array 
+ `-- 
+\emph on
+Array
+\emph default
+ 
 \series bold
 connectivity
 \end_layout
@@ -1926,8 +1937,35 @@
 \end_layout
 
 \begin_layout Standard
-Here we discuss the quadrature rules
+Here we discuss the quadrature rules available in Cigma.
 \end_layout
 
+\begin_layout Chapter
+Utilities
+\end_layout
+
+\begin_layout Standard
+Cigma comes with a couple of utilities that make the life easier to the
+ user.
+ One is called 
+\family typewriter
+h5attr
+\family default
+ and lets you see the attributes attached to a dataset inside an HDF5 file.
+ The other one is called 
+\family typewriter
+vtk-residuals
+\family default
+ and allows the user to create visualization files given a mesh and a scalar
+ array representing the residuals over the elements of the mesh.
+\end_layout
+
+\begin_layout Standard
+Normally, these utilities will be installed somewhere in your PATH during
+ the process of installation of the Cigma package, so that you can invoke
+ them from any place in your filesystem after the installation has successfully
+ finished.
+\end_layout
+
 \end_body
 \end_document