[cig-commits] r5482 - mc/3D/CitcomS/trunk/doc/manual
sue at geodynamics.org
sue at geodynamics.org
Wed Dec 6 12:33:13 PST 2006
Author: sue
Date: 2006-12-06 12:33:12 -0800 (Wed, 06 Dec 2006)
New Revision: 5482
Modified:
mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx
Log:
a few text fixes, preface to end of chapt 2
Modified: mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx
===================================================================
--- mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx 2006-12-06 18:59:56 UTC (rev 5481)
+++ mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx 2006-12-06 20:33:12 UTC (rev 5482)
@@ -532,12 +532,11 @@
\end_inset
).
- The new version incorporates
+ The new version accepts
\family typewriter
.cfg
\family default
- files on input that allow input files to be created with greater ease and
- clarity.
+ files on input, which are easier to create and read.
\end_layout
\begin_layout Standard
@@ -975,8 +974,8 @@
\end_layout
\begin_layout Standard
-If there is a phase change,
-\begin_inset LatexCommand \ref{eq:Ra, a Rayleigh number}
+If there is a phase change, equation
+\begin_inset LatexCommand \ref{eq:13}
\end_inset
@@ -1219,7 +1218,7 @@
the resolution near a curvilinear feature, as a plate boundary, unless
that plate boundary is orientated north-south or east-west.
CitComS is also capable of generating a mesh for an entire spherical shell
- in which elements in map view are approximately equal area.
+ in which elements in map view are approximately equal in area.
In the full spherical mode, CitComS has 12 caps numbered 0 to 11.
The caps are approximately square in map view so that the edges of the
square are orientated diagonally with respect to latitude and longitude.
@@ -1303,7 +1302,7 @@
\family typewriter
tar
\family default
- file) from the
+ file) available at the
\begin_inset LatexCommand \htmlurl[Geodynamics Software Packages web page]{www.geodynamics.org/cig/software/packages}
\end_inset
@@ -1403,11 +1402,11 @@
\end_inset
-, later in this chapter.
+ later in this chapter.
\end_layout
\begin_layout Standard
-Optionally, CitcomS can be configured to use a parallel HDF5 library.
+Optionally, CitComS can be configured to use a parallel HDF5 library.
See Section
\begin_inset LatexCommand \ref{sec:HDF5-Configuration}
@@ -1467,7 +1466,7 @@
\end_layout
\begin_layout Standard
-CitcomS requires a library which implements the MPI standard (either version
+CitComS requires a library which implements the MPI standard (either version
1 or 2).
Several free, open-source implementations of MPI are available.
\end_layout
@@ -1516,7 +1515,7 @@
is on your PATH.
Unfortunately, the name of this command varies from one MPI implementation
to the next.
- The CitcomS configuration script searches for the following MPI C command
+ The CitComS configuration script searches for the following MPI C command
names:
\end_layout
@@ -1562,7 +1561,7 @@
) in addition to the core Python package -- even if you don't plan on doing
any Python software development.
The development package contains the Python include files, which are necessary
- for building CitcomS.
+ for building CitComS.
\end_layout
\begin_layout Standard
@@ -1754,7 +1753,7 @@
\end_layout
\begin_layout Standard
-If you are content to run CitcomS from the build directory, then you are
+If you are content to run CitComS from the build directory, then you are
done.
Upon successful completion, the
\family typewriter
@@ -1768,7 +1767,7 @@
\family typewriter
bin
\family default
- subdirectory; this is the script you will use to run CitcomS.
+ subdirectory; this is the script you will use to run CitComS.
You may wish to add the
\family typewriter
bin
@@ -1785,7 +1784,12 @@
\family typewriter
configure
\family default
-, see the Configuration section below.
+, see section
+\begin_inset LatexCommand \ref{sec:Configuration}
+
+\end_inset
+
+ below.
\end_layout
\begin_layout Subsubsection
@@ -1793,7 +1797,7 @@
\end_layout
\begin_layout Standard
-Optionally, after building CitcomS, you can install it to a secondary location
+Optionally, after building CitComS, you can install it in a secondary location
using the
\family typewriter
make install
@@ -1806,11 +1810,11 @@
\series bold
Note:
\series default
- The following is not recommended if you plan on modifying the CitcomS source.
+ 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
+By default, CitComS is configured to install under
\family typewriter
/usr/local
\family default
@@ -1876,7 +1880,7 @@
\end_layout
\begin_layout Standard
-The above commands will install CitcomS under
+The above commands will install CitComS under
\family typewriter
$HOME/cig
\family default
@@ -1919,6 +1923,10 @@
\end_layout
\begin_layout Section
+\begin_inset LatexCommand \label{sec:Configuration}
+
+\end_inset
+
Configuration
\end_layout
@@ -1958,7 +1966,7 @@
\family typewriter
configure
\family default
- is unable to guess the value a certain parameter, you may have to specify
+ is unable to guess the value of a certain parameter, you may have to specify
the correct value by hand.
\end_layout
@@ -2022,7 +2030,7 @@
\end_layout
\begin_layout Standard
-CitcomS v2.1 requires Pythia v0.8.1.x, which
+CitComS v2.1 requires Pythia v0.8.1.x, which
\family typewriter
configure
\family default
@@ -2048,7 +2056,7 @@
\family default
packages, in addition to Pythia.
These are Python packages which are required (either directly or indirectly)
- by CitcomS.py.
+ by CitComS.py.
\end_layout
\begin_layout Subsection
@@ -2101,13 +2109,14 @@
\noindent
\align center
\begin_inset Float table
+placement H
wide false
sideways false
status open
\begin_layout Standard
\noindent
-\align left
+\align center
\begin_inset Tabular
<lyxtabular version="3" rows="5" columns="2">
<features>
@@ -2473,7 +2482,7 @@
\end_inset
-HDF5 Configuration (optional)
+HDF5 Configuration (Optional)
\end_layout
\begin_layout Standard
@@ -2669,7 +2678,7 @@
\end_layout
\begin_layout Standard
-Properly configured, Pyre can handle job submission automatically, insulating
+Properly configured, Pyre can handle job submissions automatically, insulating
users from the details of the batch system and the site configuration.
This feature has the most value when the system administrator installs
a global Pyre configuration file on the cluster (under
@@ -2688,7 +2697,7 @@
.
For more information on batch system configuration as it pertains to running
- CitcomS, see Section
+ CitComS, see Section
\begin_inset LatexCommand \vref{sub:Launchers-and-Schedulers}
\end_inset
@@ -2754,7 +2763,7 @@
\end_inset
.
- This allows users to view the revision history of the code, and check out
+ This allows users to view the revision history of the code and check out
the most recent development version of the software.
\end_layout
@@ -2763,8 +2772,7 @@
\series bold
NOTE:
\series default
-If you are content with the prepared source package, you should skip this
- section.
+If you are content with the prepared source package, you may skip this section.
\end_layout
\begin_layout Subsection
@@ -2852,17 +2860,21 @@
\family typewriter
CitcomS
\family default
- (if it doesn't already exist) and fill it with the latest CitcomS source
+ (if it doesn't already exist) and fill it with the latest CitComS source
from the CIG software repository.
\end_layout
\begin_layout Standard
-The CitcomS directory thus created is called a
+The
+\family typewriter
+CitcomS
+\family default
+ directory thus created is called a
\emph on
working copy
\emph default
.
- To merge the lastest changes into an existing working copy, use the
+ To merge the latest changes into an existing working copy, use the
\family typewriter
svn update
\family default
@@ -2886,7 +2898,7 @@
\end_layout
\begin_layout Standard
-Your working directory should now contain a fresh checkout of CitcomS:
+Your working directory should now contain a fresh checkout of CitComS:
\end_layout
\begin_layout LyX-Code
@@ -2902,7 +2914,7 @@
\end_layout
\begin_layout Standard
-But before you can run
+Before you can run
\family typewriter
configure
\family default
@@ -2981,7 +2993,7 @@
bin
\family default
directory.
- These programs do not use Python or the Pyre framework (even if CitcomS
+ These programs do not use Python or the Pyre framework (even if CitComS
was configured to use the Pyre framework).
Each program has the same usage:
\end_layout
@@ -3212,7 +3224,7 @@
\family typewriter
.pml
\family default
- file format is intended for applications in which CitcomS input files are
+ file format is intended for applications in which CitComS input files are
generated by another program; for example, a GUI, web application, or a
high-level structured editor.
This file fomat will not be discussed further here.
@@ -3467,7 +3479,7 @@
\family typewriter
PREFIX
\family default
- is the CitcomS installation directory).
+ is the CitComS installation directory).
In this directory, you will find a configuration file equivalent the previous
example:
\family typewriter
@@ -4036,7 +4048,7 @@
\family default
are pertinent to the cluster you are on, and are best customized in a configura
tion file.
- Your personal CitcomS configuration file (
+ Your personal CitComS configuration file (
\family typewriter
~/.pyre/CitcomS/CitcomS.cfg
\family default
@@ -4163,13 +4175,13 @@
\end_layout
\begin_layout Standard
-This option will cause CitcomS to print the
+This option will cause CitComS to print the
\family typewriter
mpirun
\family default
command, instead of actually executing it.
(If you're using a batch system, a job will be submitted for execution;
- when it runs, CitcomS will simply print the
+ when it runs, CitComS will simply print the
\family typewriter
mpirun
\family default
More information about the cig-commits
mailing list