[cig-commits] r7141 - cs/cigma/trunk/doc/manual

[sue at geodynamics.org]

Author: sue
Date: 2007-06-11 17:59:06 -0700 (Mon, 11 Jun 2007)
New Revision: 7141

Removed:
   cs/cigma/trunk/doc/manual/cigma-meshA-diagram.jpg
Modified:
   cs/cigma/trunk/doc/manual/cigma.lyx
Log:
moving meshA diagram

Deleted: cs/cigma/trunk/doc/manual/cigma-meshA-diagram.jpg
===================================================================
(Binary files differ)

Modified: cs/cigma/trunk/doc/manual/cigma.lyx
===================================================================
--- cs/cigma/trunk/doc/manual/cigma.lyx	2007-06-12 00:41:46 UTC (rev 7140)
+++ cs/cigma/trunk/doc/manual/cigma.lyx	2007-06-12 00:59:06 UTC (rev 7141)
@@ -137,11 +137,39 @@
 The CIG Model Analyzer (Cigma) consists of a suite of tools intended to
  facilitate the comparison of numerical models.
  CIG has developed Cigma in response to demand from the short-term tectonics
- community, who desired for a simple tool for performing rigorous error
- analysis on their FEM codes.
- The code is being released under the GNU General Public License.
+ community, who desired a simple tool for performing rigorous error analysis
+ on their FEM codes.
+ 
 \end_layout
 
+\begin_layout Standard
+This release of Cigma performs three types of tasks:
+\end_layout
+
+\begin_layout Itemize
+Error analysis
+\end_layout
+
+\begin_layout Itemize
+Benchmarking
+\end_layout
+
+\begin_layout Itemize
+Code verification
+\end_layout
+
+\begin_layout Standard
+Cigma can do analysis in two ways.
+ It can take a random sampling of points inside a domain of interest and
+ analyze the point use differences between physical fields.
+ A second way it can operate is to perform an integration over a discretized
+ version of the domain.
+\end_layout
+
+\begin_layout Standard
+The code is being released under the GNU General Public License.
+\end_layout
+
 \begin_layout Section
 Citation
 \end_layout
@@ -150,10 +178,25 @@
 Computational Infrastructure for Geodynamics (CIG) is making this source
  code available to you in the hope that the software will enhance your research
  in geophysics.
- (TODO: Use this manual for the citation?).
- CIG requests that in your oral presentations and in your papers that you
- indicate your use of this code and acknowledge the authors of the code
- and 
+ This is a brand-new code and at present no papers are published or at press
+ for use as citations other than this manual, which is cited as follows:
+\end_layout
+
+\begin_layout Standard
+Armendariz, Luis.
+ 
+\emph on
+Cigma User Manual.
+
+\emph default
+ Computational Infrastructure of Geodynamics, 2007.
+ URL: geodynamics.org/cig/software/cs/cigma/cigma.pdf
+\end_layout
+
+\begin_layout Standard
+CIG requests that in your oral presentations and in your papers that you
+ indicate your use of this code and acknowledge the author of the code and
+ 
 \begin_inset LatexCommand \htmlurl[CIG]{www.geodynamics.org}
 
 \end_inset
@@ -179,14 +222,13 @@
 \end_layout
 
 \begin_layout Standard
-(TODO: this chapter is short.
- merge chapters 1 & 2?)
-\end_layout
+To use Cigma, download the source package (in the form of a compressed tar
+ file) from the 
+\begin_inset LatexCommand \htmlurl[CIG Cigma web page]{geodynamics.org/cig/software/packages/cs/cigma}
 
-\begin_layout Standard
-To use Cigma, download the source package (in the form of a compressed tar
- file) from the Geodynamics Software Packages web page (geodynamics.org/cig/softw
-are/packages).
+\end_inset
+
+.
  After unpacking the source, use the following commands
 \end_layout
 
@@ -217,8 +259,8 @@
 \end_inset
 
 .
- You can subscribe to the Mailing List and view archived discussions at
- the 
+ You can subscribe to the cig-cs mailing list and view archived discussions
+ at the 
 \begin_inset LatexCommand \htmlurl[CIG Mail Lists web page]{geodynamics.org/cig/lists}
 
 \end_inset
@@ -226,7 +268,7 @@
 .
  If you encounter any bugs or have problems installing Cigma, please submit
  a report to the 
-\begin_inset LatexCommand \htmlurl[CIG Issue Tracker]{geodynamics.org/bugs}
+\begin_inset LatexCommand \htmlurl[CIG Bug Tracker]{geodynamics.org/bugs}
 
 \end_inset