[cig-commits] r3842 - in
short/3D/PyLith/branches/pylith-0.8/doc/userguide:
fileformats install runpylith tutorials/tutorialbm5
baagaard at geodynamics.org
baagaard at geodynamics.org
Wed Jun 21 14:30:31 PDT 2006
Author: baagaard
Date: 2006-06-21 14:30:31 -0700 (Wed, 21 Jun 2006)
New Revision: 3842
Modified:
short/3D/PyLith/branches/pylith-0.8/doc/userguide/fileformats/fileformats.xml
short/3D/PyLith/branches/pylith-0.8/doc/userguide/install/install.xml
short/3D/PyLith/branches/pylith-0.8/doc/userguide/runpylith/runpylith.xml
short/3D/PyLith/branches/pylith-0.8/doc/userguide/tutorials/tutorialbm5/tutorialbm5.xml
Log:
User guide. Started filling in installation instructions. Worked more on running PyLith and tutorial.
Modified: short/3D/PyLith/branches/pylith-0.8/doc/userguide/fileformats/fileformats.xml
===================================================================
--- short/3D/PyLith/branches/pylith-0.8/doc/userguide/fileformats/fileformats.xml 2006-06-21 20:22:04 UTC (rev 3841)
+++ short/3D/PyLith/branches/pylith-0.8/doc/userguide/fileformats/fileformats.xml 2006-06-21 21:30:31 UTC (rev 3842)
@@ -1,7 +1,7 @@
<?xml version="1.0"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
-<chapter id="chapter_fileformats">
+<chapter id="appendix_fileformats">
<title>File Formats</title>
<para>
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 20:22:04 UTC (rev 3841)
+++ short/3D/PyLith/branches/pylith-0.8/doc/userguide/install/install.xml 2006-06-21 21:30:31 UTC (rev 3842)
@@ -15,25 +15,203 @@
<!-- SECTION +++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<section>
<title>Getting Help</title>
+
<para>
ADD STUFF HERE
</para>
- </section>
- <!-- SECTION +++++++++++++++++++++++++++++++++++++++++++++++++++ -->
- <section>
- <title>System Requirements</title>
- <para>
- ADD STUFF HERE
- </para>
+ <!-- SECTION +++++++++++++++++++++++++++++++++++++++++++++++++ -->
+ <section>
+ <title>Requesting help</title>
+
+ <para>
+ Send email to cig-short at geodynamics.org. ADD STUFF HERE
+ </para>
+ </section>
+
+ <!-- SECTION +++++++++++++++++++++++++++++++++++++++++++++++++ -->
+ <section>
+ <title>Reporting errors</title>
+
+ <para>
+ Submit bug reports using Roundup. ADD STUFF HERE
+http://www.geodynamics.org/roundup/issues/
+ </para>
+ </section>
+
</section>
<!-- SECTION +++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<section>
<title>Installation</title>
<para>
- ADD STUFF HERE
+ Binary executables are available for three of the most widely
+ used platforms: 32-bit Linux, OSX (Darwin), and Windows. If your
+ platform is not compatible with any of these, you can build the
+ software from the source code.
</para>
+
+ <!-- SECTION +++++++++++++++++++++++++++++++++++++++++++++++++ -->
+ <section>
+ <title>Linux</title>
+
+ <para>
+ Running the Linux binary version of PyLith requires a 32-bit
+ compatible machine with GLIBC 2.2 or later.
+ </para>
+
+ <orderedlist>
+ <listitem>
+ <para>
+ Download the <ulink
+ url="http://crust.geodynamics.org/~leif/shipping/">tarball</ulink>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Unpack the tarball (i.e., <command>tar -zxvf
+ pylith-0.8-linux-x86.tar.gz</command>) in a suitable
+ location.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Add <filename
+ class="directory">pylith-0.8-linux-x86/bin</filename> to
+ your <envar>PATH</envar>. You will likely want to add
+ something like
+ <literal>PATH=${PATH}:replace_with_absolute_path/pylith-0.8-linux-x86/bin</literal>
+ to your <filename>.bashrc</filename> file (if you are
+ using bash as your shell) or the equivalent to your
+ <filename>.cshrc</filename> file (if you are using tcsh as
+ your shell).
+ </para>
+ </listitem>
+ </orderedlist>
+
+ </section>
+
+ <!-- SECTION +++++++++++++++++++++++++++++++++++++++++++++++++ -->
+ <section>
+ <title>OSX (Darwin)</title>
+
+ <para>
+ ADD STUFF HERE
+ </para>
+ </section>
+
+ <!-- SECTION +++++++++++++++++++++++++++++++++++++++++++++++++ -->
+ <section>
+ <title>Windows</title>
+
+ <para>
+ This Windows binary version of PyLith should be compatible
+ with Windows NT, Windows 2000, and Windows XP.
+ </para>
+
+ <orderedlist>
+ <listitem>
+ <para>
+ Download the <ulink
+ url="http://crust.geodynamics.org/~leif/shipping/">installer</ulink>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Double click on the <filename>setup.exe</filename> file
+ you just downloaded and follow the instructions for
+ installing.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ ADD HOW TO RUN
+ </para>
+ </listitem>
+ </orderedlist>
+ </section>
+
+ <!-- SECTION +++++++++++++++++++++++++++++++++++++++++++++++++ -->
+ <section>
+ <title>Building the source code</title>
+
+ <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.
+ </para>
+
+ <!-- SECTION +++++++++++++++++++++++++++++++++++++++++++++++ -->
+ <section>
+ <title>System Requirements</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>Unix flavored operating system</para>
+ </listitem>
+ <listitem>
+ <para>Fortran, C, and C++ compilers</para>
+ </listitem>
+ <listitem>
+ <para>Python (2.3 or later)</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <para>
+ The software must be built starting from the bottom of the
+ dependency list and working upwards. The steps below describe
+ the recommended way to build PyLith and the external packages
+ on which it depends. Some of the dependencies can be satisfied
+ using precompiled binaries (e.g., RedHat and Fink
+ packages). When choosing whether to use a precompiled binary
+ package to satisfy any of the dependencies remember that all
+ of the compilers and settings used in building the code must
+ be compatible.
+ </para>
+
+ <orderedlist>
+ <listitem>
+ <para>
+ Build PETSc and MPI.
+ </para>
+ <orderedlist numeration="lowerroman">
+ <listitem>
+ <para>
+ ADD STUFF HERE
+ </para>
+ </listitem>
+ </orderedlist>
+ </listitem>
+ <listitem>
+ <para>
+ Build Pythia.
+ </para>
+ <orderedlist numeration="lowerroman">
+ <listitem>
+ <para>
+ ADD STUFF HERE
+ </para>
+ </listitem>
+ </orderedlist>
+ </listitem>
+ <listitem>
+ <para>
+ Build PyLith.
+ </para>
+ <orderedlist numeration="lowerroman">
+ <listitem>
+ <para>
+ ADD STUFF HERE
+ </para>
+ </listitem>
+ </orderedlist>
+ </listitem>
+ </orderedlist>
+
+ </section>
+
</section>
</chapter>
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 20:22:04 UTC (rev 3841)
+++ short/3D/PyLith/branches/pylith-0.8/doc/userguide/runpylith/runpylith.xml 2006-06-21 21:30:31 UTC (rev 3842)
@@ -10,8 +10,9 @@
<para>
PyLith currently only supports the 4-node linear tetrahedral
element. The node ordering must follow the convention shown in
- <xref linkend="fig_tet4" />.
- CHARLES- IS THIS CORRECT??
+ <xref linkend="fig_tet4" />. Support for the 8-node linear
+ hexahedral element will be included in PyLith version 0.8.1,
+ expected to be released in July 2006.
</para>
<figure id="fig_tet4">
@@ -35,7 +36,7 @@
associated with different kinds of boundary conditions. As a
result only six are required. The remaining files are only used
when the associated boundary condition is used. See <xref
- linkend="chapter_fileformats" /> for a detailed discussion of
+ linkend="appendix_fileformats" /> for a detailed discussion of
the file formats.
</para>
<para>
@@ -54,7 +55,9 @@
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.
+ simulation. See <filename>runbm5.sh</filename> in <xref
+ linkend="tutorial_scecbm5" /> for an illustration of how to do
+ this.
</para>
<!-- SECTION +++++++++++++++++++++++++++++++++++++++++++++++++ -->
@@ -325,8 +328,11 @@
<para>
PyLith's Pyre properties can also be set using
<filename>pml</filename> files. These are <acronym>XML</acronym>
- files that follow a special Pyre schema. ADD STUFF HERE
+ files that follow a special Pyre XML schema.
</para>
+ <para>
+ ADD STUFF HERE
+ </para>
</section>
Modified: short/3D/PyLith/branches/pylith-0.8/doc/userguide/tutorials/tutorialbm5/tutorialbm5.xml
===================================================================
--- short/3D/PyLith/branches/pylith-0.8/doc/userguide/tutorials/tutorialbm5/tutorialbm5.xml 2006-06-21 20:22:04 UTC (rev 3841)
+++ short/3D/PyLith/branches/pylith-0.8/doc/userguide/tutorials/tutorialbm5/tutorialbm5.xml 2006-06-21 21:30:31 UTC (rev 3842)
@@ -1,7 +1,7 @@
<?xml version="1.0"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
-<section id="section_tutorial_scecbm5">
+<section id="tutorial_scecbm5">
<title>Tutorial Using SCEC Benchmark 5</title>
<!-- SECTION +++++++++++++++++++++++++++++++++++++++++++++++++++ -->
@@ -572,7 +572,9 @@
dialog box and the click the <guibutton>Open</guibutton>
button. Click the <guibutton>Accept</guibutton> button. You
can now visualize the datasets just like you did for the
- single processor case.
+ single processor case. By making the datasets from the
+ different processors all visible you can examine the
+ aggregate output.
</para>
</listitem>
</orderedlist>
More information about the Cig-commits
mailing list