[cig-commits] r14694 - doc/CitcomS/manual

Tue Apr 14 11:33:21 PDT 2009

Author: tan2
Date: 2009-04-14 11:33:21 -0700 (Tue, 14 Apr 2009)
New Revision: 14694

Modified:
   doc/CitcomS/manual/citcoms.lyx
Log:
Udated Installation chapter.

* Don't recommend 'make install'
* Note about using HDF5
* Mentioned CFLAGS


Modified: doc/CitcomS/manual/citcoms.lyx
===================================================================

--- doc/CitcomS/manual/citcoms.lyx	2009-04-14 18:19:09 UTC (rev 14693)
+++ doc/CitcomS/manual/citcoms.lyx	2009-04-14 18:33:21 UTC (rev 14694)
@@ -1892,32 +1892,16 @@
 \end_layout
 
 \begin_layout Standard
-To install CitcomS, follow the procedure that is commonly used with other
- open-source software packages.
- First, download the source package (in the form of a compressed 
-\family typewriter
-tar
-\family default
- file) available at the 
-\begin_inset LatexCommand htmlurl
-name "Geodynamics Software Packages web page"
-target "geodynamics.org/cig/software/packages/mc/citcoms"
-
-\end_inset
-
-.
- After unpacking the source, you run a prepackaged shell script to configure
- CitcomS for your system.
- Finally, use the 
-\family typewriter
-make
-\family default
- utility to build and, optionally, install CitcomS from source.
+CitcomS has been tested on Linux, Mac OS X, Sun Solaris and several NSF
+ TeraGrid platforms.
+ You should have no trouble installing CitcomS on most Unix-like systems.
  
 \end_layout
 
 \begin_layout Standard
-Advanced users and software developers may be interested in downloading
+Most users will install CitcomS from the released source package.
+ The following sections will lead you through the installation process.
+ Advanced users and software developers may be interested in downloading
  the latest CitcomS source code directly from the CIG source code repository,
  instead of using the prepared source package; see Section 
 \begin_inset LatexCommand ref
@@ -1928,11 +1912,6 @@
  later in this chapter.
 \end_layout
 
-\begin_layout Standard
-CitcomS has been tested on Linux, Mac OS X, and several NSF TeraGrid platforms.
- 
-\end_layout
-
 \begin_layout Section
 Getting Help
 \end_layout
@@ -1975,7 +1954,7 @@
 
 \begin_layout Itemize
 Python 2.3 or greater (Python 2.4 or greater is required on 64-bit machines),
- including header files
+ including header files, if using Pyre.
 \end_layout
 
 \begin_layout Standard
@@ -2476,84 +2455,34 @@
 make install
 \family default
  command.
+ This is not necessary for using CitcomS and is not recommended for most
+ situations.
+ It is documented only for sake of completeness.
 \end_layout
 
-\begin_layout Quotation
-
-\series bold
-Note:
-\series default
- The following is not recommended if you plan on modifying the CitcomS source.
-\end_layout
-
 \begin_layout Standard
 By default, CitcomS is configured to install under 
 \family typewriter
 /usr/local
 \family default
-, which requires that you become 
+, which is not writable by normal users.
+ To install as an ordinary user, give 
 \family typewriter
-root
-\family default
- before issuing the 
-\family typewriter
 make install
 \family default
- command.
-\end_layout
-
-\begin_layout LyX-Code
-
-\family typewriter
-$ su
-\end_layout
-
-\begin_layout LyX-Code
-
-\family typewriter
-Password:
-\end_layout
-
-\begin_layout LyX-Code
-
-\family typewriter
-# make install
-\end_layout
-
-\begin_layout Standard
-To install as an ordinary user instead of 
-\family typewriter
-root
-\family default
-, give 
-\family typewriter
-configure
-\family default
  the 
 \family typewriter
---prefix
+prefix
 \family default
  option, specifying a directory to which you have write access:
 \end_layout
 
 \begin_layout LyX-Code
-$ cd CitcomS-3.0.3
+$ make install prefix=$HOME/cig
 \end_layout
 
-\begin_layout LyX-Code
-$ ./configure --prefix=$HOME/cig
-\end_layout
-
-\begin_layout LyX-Code
-$ make
-\end_layout
-
-\begin_layout LyX-Code
-$ make install
-\end_layout
-
 \begin_layout Standard
-The above commands will install CitcomS under 
+The above command will install CitcomS under 
 \family typewriter
 $HOME/cig
 \family default
@@ -2802,7 +2731,7 @@
 \noindent
 \align center
 \begin_inset Tabular
-<lyxtabular version="3" rows="5" columns="2">
+<lyxtabular version="3" rows="6" columns="2">
 <features>
 <column alignment="center" valignment="top" leftline="true" width="1in">
 <column alignment="left" valignment="top" leftline="true" rightline="true" width="3.5in">
@@ -2946,6 +2875,27 @@
 \begin_inset Text
 
 \begin_layout Standard
+CFLAGS
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+C compiler flags.
+ This can be set for optimization flags.
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
 CPPFLAGS
 \end_layout
 
@@ -3267,7 +3217,7 @@
 \begin_layout Standard
 For writing its output in binary format, CitcomS requires parallel HDF5
  (PHDF5).
- In turn, PHDF5 requires an MPI compiler with MPI-IO support and a parallel
+ In turn, PHDF5 requires an MPI library with MPI-IO support and a parallel
  file system.
  If an existing installation of the PHDF5 library is not available on your
  cluster, you can compile it from source by following the instructions in
@@ -3293,6 +3243,22 @@
  packages.
 \end_layout
 
+\begin_layout Quote
+
+\series bold
+NOTE:
+\series default
+ Most post-processing and visualization scripts discussed in Chapter 
+\begin_inset LatexCommand ref
+reference "cha:Postprocessing-and-Graphics"
+
+\end_inset
+
+ only understand ASCII output.
+ An additional step to convert the HDF5 output files to ASCII files in necessary
+ before using those scripts.
+\end_layout
+
 \begin_layout Standard
 By default, CitcomS will attempt to auto-detect your PHDF5 installation,
  and will disable HDF5 support if it is not found.
@@ -3509,7 +3475,7 @@
  
 \begin_inset LatexCommand htmlurl
 name "Pythia page"
-target "geodynamics.org/cig/software/packages/cs/pythia"
+target "geodynamics.org/cig/software/packages/cs/pythia/docs/batch"
 
 \end_inset
 

