[cig-commits] r3844 - in
short/3D/PyLith/branches/pylith-0.8/doc/userguide: . install
runpylith
baagaard at geodynamics.org
baagaard at geodynamics.org
Wed Jun 21 16:58:31 PDT 2006
Author: baagaard
Date: 2006-06-21 16:58:31 -0700 (Wed, 21 Jun 2006)
New Revision: 3844
Modified:
short/3D/PyLith/branches/pylith-0.8/doc/userguide/install/install.xml
short/3D/PyLith/branches/pylith-0.8/doc/userguide/preface.xml
short/3D/PyLith/branches/pylith-0.8/doc/userguide/runpylith/runpylith.xml
Log:
User guide. Worked more on getting help and running PyLith.
Modified: short/3D/PyLith/branches/pylith-0.8/doc/userguide/install/install.xml
===================================================================
--- short/3D/PyLith/branches/pylith-0.8/doc/userguide/install/install.xml 2006-06-21 23:12:55 UTC (rev 3843)
+++ short/3D/PyLith/branches/pylith-0.8/doc/userguide/install/install.xml 2006-06-21 23:58:31 UTC (rev 3844)
@@ -8,7 +8,13 @@
<section>
<title>Introduction</title>
<para>
- ADD STUFF HERE
+ Installation of PyLith on a desktop or laptop machine is, in
+ most cases, very easy. Binary packages have been created for the
+ most common platforms, including Linux, OSX, and
+ Windows. Installation on machines that are not compatible with
+ any of these operating systems requires building the software
+ from the source code, which can be difficult for inexperienced
+ users.
</para>
</section>
@@ -17,7 +23,8 @@
<title>Getting Help</title>
<para>
- ADD STUFF HERE
+ Help is available via the CIG Short-Term Crustal Dynamics
+ Mailing List and CIG's issue tracking system.
</para>
<!-- SECTION +++++++++++++++++++++++++++++++++++++++++++++++++ -->
@@ -25,17 +32,31 @@
<title>Requesting help</title>
<para>
- Send email to cig-short at geodynamics.org. ADD STUFF HERE
+ The CIG Short-Term Crustal Dynamics Mailing List,
+ <email>cig-short at geodynamics.org</email>, is a mailing list
+ dedicated to CIG issues associated with short-term crustal
+ dynamics, including the use of PyLith. You can subscribe to
+ the mailing list and view messages at the <ulink
+ url="http://www.geodynamics.org">CIG website</ulink>.
</para>
</section>
<!-- SECTION +++++++++++++++++++++++++++++++++++++++++++++++++ -->
<section>
- <title>Reporting errors</title>
+ <title>Reporting bugs and errors</title>
<para>
- Submit bug reports using Roundup. ADD STUFF HERE
-http://www.geodynamics.org/roundup/issues/
+ CIG uses the <application>Roundup</application> for bug
+ tracking. If you find a bug in PyLith, please submit a bug
+ report to the <ulink
+ url="http://www.geodynamics.org/roundup">CIG
+ <application>Roundup</application> system</ulink>. Of course,
+ it is helpful to first check to see if someone else has
+ already submitted a report related to the issue; one of the
+ CIG developers may have already posted a solution to the
+ problem. You can reply to a current issue by clicking on the
+ issue title. To submit a new issue, click on <guibutton>Create
+ New</guibutton> under <guimenu>Issues</guimenu>.
</para>
</section>
@@ -138,8 +159,8 @@
<para>
Building PyLith from the source code is not a trivial task
because PyLith depends on several other packages. In general,
- each package must be compiled from source using binary compatible
- compilers.
+ each package must be compiled from source using compilers for
+ each language that are compatible with one another.
</para>
<!-- SECTION +++++++++++++++++++++++++++++++++++++++++++++++ -->
Modified: short/3D/PyLith/branches/pylith-0.8/doc/userguide/preface.xml
===================================================================
--- short/3D/PyLith/branches/pylith-0.8/doc/userguide/preface.xml 2006-06-21 23:12:55 UTC (rev 3843)
+++ short/3D/PyLith/branches/pylith-0.8/doc/userguide/preface.xml 2006-06-21 23:58:31 UTC (rev 3844)
@@ -66,8 +66,8 @@
<title>Request for Comments</title>
<para>
Your suggestions and corrections can only improve this
- documentation. Please report any errors, inaccuracies, bugs,
- or typos to cassie (at) geodynamics.org.
+ documentation. Please report any errors, inaccuracies, or typos
+ to cassie (at) geodynamics.org.
</para>
</section>
Modified: short/3D/PyLith/branches/pylith-0.8/doc/userguide/runpylith/runpylith.xml
===================================================================
--- short/3D/PyLith/branches/pylith-0.8/doc/userguide/runpylith/runpylith.xml 2006-06-21 23:12:55 UTC (rev 3843)
+++ short/3D/PyLith/branches/pylith-0.8/doc/userguide/runpylith/runpylith.xml 2006-06-21 23:58:31 UTC (rev 3844)
@@ -43,22 +43,28 @@
The first step in the simulation process involves partitioning
the mesh among the processors. In this phase, PyLith reads in
the entire mesh and then writes out processor specific pieces
- with one file for each processor. The filenames for these
- processors follow the convention
- <filename>xx.PROC.ext</filename> where <filename>PROC</filename>
- refers to the processor number and the original filename was
- <filename>xx.ext</filename>. This procedure is applied to files
- with the following extensions: <filename>coord</filename>,
- <filename>connect</filename>, <filename>split</filename>,
- <filename>bc</filename>. The other files provide information
- common to all processors. As a result, the user must create
- copies of each one for each of the processors with filenames
- following the same form <filename>xx.PROC.ext</filename>. This
- is most easily done using a shell script that starts a
- simulation. See <filename>runbm5.sh</filename> in <xref
- linkend="tutorial_scecbm5" /> for an illustration of how to do
- this.
+ with one file for each processor. The filenames for these follow
+ the convention <filename>xx.PROC.ext</filename> where
+ <filename>PROC</filename> refers to the processor number and the
+ original filename was <filename>xx.ext</filename>. This
+ procedure is applied to files with the following extensions:
+ <filename>coord</filename>, <filename>connect</filename>,
+ <filename>split</filename>, <filename>bc</filename>.
</para>
+ <para>
+ The other files provide information common to all processors. As
+ a result, the user must create copies of each one for each of
+ the processors with filenames. By default PyLith expects the
+ names of these files to follow the same form
+ <filename>xx.PROC.ext</filename>. Setting up this naming scheme
+ is most easily done using symbolic links or copying files to
+ local directories on each machine using a shell script that
+ starts a simulation. See <filename>runbm5.sh</filename> in <xref
+ linkend="tutorial_scecbm5" /> for a simple example. You can also
+ choose your own filename template by setting the appropriate
+ command-line argument. See <xref
+ linkend="section_commandline_arguments" /> for more information.
+ </para>
<!-- SECTION +++++++++++++++++++++++++++++++++++++++++++++++++ -->
<section>
@@ -125,9 +131,11 @@
<section>
<title>Optional Input Files</title>
<para>
- The optional input files are only included when the associated
- boundary conditions are specified in the boundary condition
- file, <filename>xx.bc</filename>.
+ The optional input files are only read when they exist in the
+ directory containing the rest of the input files. Explicit
+ filenames (with alternate locations) can be specified using
+ command-line arguments as discussed in <xref
+ linkend="section_commandline_arguments" />.
</para>
<variablelist>
<varlistentry>
@@ -170,7 +178,7 @@
<listitem>
<para>
Winkler sprint element boundary condition
- information. Not yet tested.
+ information. <emphasis>Not yest tested.</emphasis>
</para>
</listitem>
</varlistentry>
@@ -178,9 +186,8 @@
<term><filename>xx.hist</filename></term>
<listitem>
<para>
- Time history boundary conditions. Not yet tested??
- CHARLES - IS THIS FOR DISLOCATION BOUNDARY CONDITIONS OR
- EXTERNAL BOUNDARY CONDITIONS??
+ Time history split node and Winkler boundary
+ conditions. <emphasis>Not yest tested.</emphasis>
</para>
</listitem>
</varlistentry>
@@ -190,7 +197,7 @@
</section>
<!-- SECTION +++++++++++++++++++++++++++++++++++++++++++++++++++ -->
- <section>
+ <section id="section_commandline_arguments">
<title>Command-line Arguments</title>
<para>
Command-line arguments associated with running PyLith fall into
More information about the Cig-commits
mailing list