[cig-commits] r5855 - long/3D/Gale/trunk/documentation

[sue at geodynamics.org]

Author: sue
Date: 2007-01-22 11:35:36 -0800 (Mon, 22 Jan 2007)
New Revision: 5855

Modified:
   long/3D/Gale/trunk/documentation/gale.lyx
   long/3D/Gale/trunk/documentation/gale.pdf
Log:
added binaries instructions

Modified: long/3D/Gale/trunk/documentation/gale.lyx
===================================================================
--- long/3D/Gale/trunk/documentation/gale.lyx	2007-01-22 18:13:00 UTC (rev 5854)
+++ long/3D/Gale/trunk/documentation/gale.lyx	2007-01-22 19:35:36 UTC (rev 5855)
@@ -726,21 +726,68 @@
 \end_layout
 
 \begin_layout Standard
-Gale works on a variety of platforms.
- It requires PETSc, MPI, and libxml2 headers and development libraries.
- It also requires Python 2.2.1 or greater to build.
+Gale works on a variety of platforms and has been tested on workstations
+ running 
 \end_layout
 
+\begin_layout Itemize
+Mac OS X 10.4.6 (G4 and G5)
+\end_layout
+
+\begin_layout Itemize
+Windows 2000 and XP SP2
+\end_layout
+
+\begin_layout Itemize
+RedHat Fedora Core 5 (x86)
+\end_layout
+
+\begin_layout Itemize
+OpenSuse 10.0 (x86)
+\end_layout
+
+\begin_layout Itemize
+Gentoo (x86)
+\end_layout
+
+\begin_layout Itemize
+Debian stable (x86 and AMD64), testing (x86), and unstable (x86)
+\end_layout
+
 \begin_layout Standard
-Gale has been tested on workstations running Mac OS X 10.4.6 (G4 and G5);
- Windows 2000 and XP SP2; RedHat Fedora Core 5 (x86); OpenSuse 10.0 (x86);
- Gentoo (x86); Debian stable (x86 and AMD64), testing (x86), and unstable
- (x86).
- Gale has also been tested on clusters running Redhat 7.2 (x86) and RedHat
+Gale has also been tested on clusters running Redhat 7.2 (x86) and RedHat
  Enterprise Linux 3 (EM64T).
 \end_layout
 
 \begin_layout Section
+Dependencies
+\end_layout
+
+\begin_layout Standard
+In order to install Gale, you must have the headers and development libraries
+ for
+\end_layout
+
+\begin_layout Itemize
+MPI
+\end_layout
+
+\begin_layout Itemize
+Petsc 2.3.0 or 2.3.1, but not 2.3.2
+\end_layout
+
+\begin_layout Itemize
+libxml2
+\end_layout
+
+\begin_layout Standard
+You must also have python 2.2.1 or greater installed.
+ If you do not already have MPI, then in many cases Petsc can install a
+ version for you.
+ Installing Petsc also requires a Blas/Lapack implementation.requires 
+\end_layout
+
+\begin_layout Section
 Getting the Code
 \end_layout
 
@@ -787,14 +834,246 @@
 \end_layout
 
 \begin_layout Standard
-Installation instructions are available in the tarball in the file INSTALL.
- For some platforms (Mac OS X, Windows, RedHat Fedora Core 5, OpenSuse 10.0,
- Debian stable, testing, and unstable) there are platform specific installation
- instructions.
- Generally, the hardest part is not installing Gale itself, but PETSc.
+Installation instructions are given below as well as in the tarball in the
+ file INSTALL.
+ For some platforms (Linux, Mac OS X, and Windows 2000/XP), binaries are
+ available.
+ 
 \end_layout
 
+\begin_layout Subsection
+Linux
+\end_layout
+
+\begin_layout Standard
+Running the Linux binary version of Gale requires a 32-bit compatible machine
+ with GLIBC 2.2 or later.
+\end_layout
+
+\begin_layout Enumerate
+\noindent
+Download the 
+\family typewriter
+\size footnotesize
+
+\begin_inset LatexCommand \htmlurl[tarball]{www.geodynamics.org/cig/software/packages/long/gale/Gale-Linux-1.0.1.tar.gz}
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Enumerate
+\noindent
+Unpack the tarball in a suitable location
+\newline
+
+\newline
+
+\family typewriter
+\color black
+$ tar -zxvf Gale-Linux-1.1.tar.gz
+\end_layout
+
+\begin_layout Enumerate
+Add 
+\family typewriter
+Gale/bin
+\family default
+ to your 
+\family typewriter
+PATH
+\family default
+.
+ You will likely want to add something like
+\newline
+
+\newline
+
+\family typewriter
+PATH=${PATH}:
+\emph on
+replace_with_absolute_path
+\emph default
+/Gale/bin
+\family default
+
+\newline
+
+\newline
+to your 
+\family typewriter
+.bashrc 
+\family default
+file (if you are using bash as your shell) or the equivalent to your 
+\family typewriter
+.cshrc
+\family default
+ file (if you are using tcsh as your shell).
+ 
+\end_layout
+
+\begin_layout Enumerate
+\noindent
+Add 
+\family typewriter
+Gale/lib
+\family default
+ to your 
+\family typewriter
+LD_LIBRARY_PATH
+\family default
+.
+ You will likely want to add something like 
+\size footnotesize
+
+\newline
+
+\newline
+
+\family typewriter
+export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:
+\emph on
+replace_with_absolute_path
+\emph default
+/Gale/lib
+\family default
+\size default
+
+\newline
+
+\newline
+to your 
+\family typewriter
+.bashrc
+\family default
+ file (if you are using bash as your shell) or the equivalent to your 
+\family typewriter
+.cshrc
+\family default
+ file (if you are using tcsh as your shell).
+ 
+\end_layout
+
+\begin_layout Enumerate
+At the command line, cd to the install directory and run
+\end_layout
+
+\begin_layout LyX-Code
+./Gale extention.xml
+\end_layout
+
+\begin_layout Subsection
+Mac OS X
+\end_layout
+
+\begin_layout Standard
+The OS X binary version was built to run on the Macintosh PowerPC architecture
+ with OS X version 10.4.
+ The binary will run on the Macintosh Intel architecture, but only in emulation
+ mode (i.e., rather slowly).
+\end_layout
+
+\begin_layout Enumerate
+Download the 
+\begin_inset LatexCommand \htmlurl[disk image]{www.geodynamics.org/cig/software/packages/long/gale/Gale-Mac-1_1.dmg}
+
+\end_inset
+
+.
+ 
+\end_layout
+
+\begin_layout Enumerate
+Double click on the disk image to mount the disk.
+ 
+\end_layout
+
+\begin_layout Enumerate
+Double click on the disk and copy the 
+\family typewriter
+PyLith
+\family default
+ folder to a suitable location.
+ 
+\end_layout
+
+\begin_layout Enumerate
+At the command line, cd to the install directory and run
+\end_layout
+
+\begin_layout LyX-Code
+./Gale extention.xml
+\end_layout
+
+\begin_layout Subsection
+Windows
+\end_layout
+
+\begin_layout Standard
+This Windows binary version of PyLith should be compatible with Windows
+ NT, Windows 2000, and Windows XP.
+\end_layout
+
+\begin_layout Enumerate
+Download the 
+\begin_inset LatexCommand \htmlurl[installer]{www.geodynamics.org/cig/software/packages/long/gale/Gale-Win32-1_1.zip}
+
+\end_inset
+
+.
+ 
+\end_layout
+
+\begin_layout Enumerate
+Unpack the .zip file you just downloaded
+\end_layout
+
+\begin_layout Enumerate
+At the command line, cd to the install directory and run
+\end_layout
+
+\begin_layout LyX-Code
+./Gale extention.xml
+\end_layout
+
 \begin_layout Section
+Building Using Source Tarball
+\end_layout
+
+\begin_layout Standard
+For building from source, platform-specific installation instructions are
+ given for Mac OS X, Windows, RedHat Fedora Core 5, OpenSuse 10.0, and Debian
+ stable, testing, and unstable in the tarball in the file 
+\family typewriter
+INSTALL
+\family default
+.
+ Generally, the hardest part is not installing Gale itself, but PETSc.The
+ stable version of the Gale source code is available at
+\newline
+
+\family typewriter
+
+\newline
+\InsetSpace ~
+\InsetSpace ~
+\InsetSpace ~
+cig/software/Repository/cig/long/3D/Gale/trunk
+\family default
+
+\newline
+
+\newline
+in the 
+\begin_inset LatexCommand \htmlurl[Geodynamics Subversion Repository]{www.geodynamics.org/cig/software/Repository/}
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Section
 Support
 \end_layout
 
@@ -831,7 +1110,7 @@
 \end_layout
 
 \begin_layout Standard
-to submit bugs.
+to submit bugs and request features.
 \end_layout
 
 \begin_layout Chapter

Modified: long/3D/Gale/trunk/documentation/gale.pdf
===================================================================
(Binary files differ)