[cig-commits] commit: Add INSTALL and INSTALL.MACOSX

[Mercurial]

changeset:   277:5a86889f2ff5
user:        Walter Landry <wlandry at caltech.edu>
date:        Thu Apr 01 07:09:25 2010 -0700
files:       INSTALL INSTALL.MACOSX
description:
Add INSTALL and INSTALL.MACOSX


diff -r 4c99349a001b -r 5a86889f2ff5 INSTALL
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/INSTALL	Thu Apr 01 07:09:25 2010 -0700
@@ -0,0 +1,99 @@
+These are generic installation instuctions.  Gale has been tested on
+workstations running Mac OS X, Windows XP SP2, Debian Lenny and
+Squeeze, and Ubuntu Hardy Heron.  There are platform specific
+instructions for some of these platforms (e.g. INSTALL.MACOSX for
+Mac).
+
+
+Dependencies
+------------
+
+In order to install Gale, you must have the headers and development
+libraries for
+
+        - MPI
+        - PETSc 3.0.0
+        - libxml2
+
+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.
+
+Generally, the most difficult part is installing PETSc.
+
+Configure
+---------
+
+The first step in installing Gale is running the script
+"configure.sh".  This script examines your system, looking for
+dependencies.  If you are lucky, configure.sh will be able to find
+everything.  But many times, you will have to tell "configure.sh"
+where different packages are.  For example, suppose you installed
+PETSc in /opt/goodies/petsc.  Then you can tell "configure.sh" where
+PETSc is with the --petsc-dir option
+
+  ./configure.sh --petsc-dir=/opt/goodies/petsc
+
+PETSc has a mechanism for letting multiple installations of PETSc
+coexist in a single directory (PETSC_ARCH).  If you have multiple
+installations, Gale will use the first one it finds. To override that
+guess, specify PETSC_ARCH with the option --petsc-arch
+
+  ./configure.sh --petsc-dir=/opt/goodies/petsc --petsc-arch=linux-gnu
+
+configure.sh also checks the environment variables PETSC_DIR and
+PETSC_ARCH.
+
+For the other dependencies, configure.sh accepts the options
+
+  --libxml2-inc-dir
+  --libxml2-lib-dir
+
+  --mpi-dir
+  --mpi-inc-dir
+  --mpi-lib-dir
+
+There are more options for advanced use.  To get a list of all
+available options, invoke configure.sh with --help
+
+  ./configure.sh --help
+
+configure.sh saves a copy of everything it does in "config.log".
+When sending in bug reports, always include a copy of "config.log".
+
+After a successful configure, the results are written into
+"config.cfg".  You can manually tune the parameters there, but it will
+be overwritten if you run configure again.
+
+Building
+--------
+
+Once you have configured successfully, run SCons
+
+  ./scons
+
+This will build all of the libraries and header files that are needed
+for Gale.  If you want to run a parallel build because your machine
+has two processors
+
+  ./scons -j 2
+
+The binary will be in
+
+  build/bin/Gale
+
+Testing
+-------
+
+There are a number of cookbook examples.  To run the yielding model type
+
+  bin/Gale input/cookbook/yielding.xml
+
+For some MPI implementations, you may have to speficy the complete
+path to the input file
+
+  bin/Gale /home/juser/gale/input/cookbook/yielding.xml
+
+If you find any bugs, please send a meesage to
+
+  cig-long at geodynamics.org
diff -r 4c99349a001b -r 5a86889f2ff5 INSTALL.MACOSX
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/INSTALL.MACOSX	Thu Apr 01 07:09:25 2010 -0700
@@ -0,0 +1,37 @@
+Mac OS X
+--------
+
+We have not tested Gale with fink.  We recommend that you install the
+developer tools.  You must become a member of ADC in order to get them
+(it is free).
+
+  http://developer.apple.com/
+
+Once those are installed, you have to install petsc.  Petsc will
+download mpi for you.  So once you have gotten the petsc tarball from
+the website (3.0.0), unpack it and cd into the directory.  Configure
+it with
+
+  export PETSC_DIR=$PWD
+  config/configure.py --download-mpich=1 --with-external-packages-dir=/path/to/install/mpich
+  
+This may take a little while.  You can install it elsewhere by giving
+a different argument to --prefix.  When it is done, petsc will tell
+you to set PETSC_ARCH.  It will probably be something like
+
+  export PETSC_ARCH=darwin8.6.0-c-real-debug
+
+Then run
+
+  make all
+  make install
+
+to build and install petsc.
+
+To build Gale, cd into the Gale directory and run
+
+  configure.py --with-mpi-dir=/path/to/install/mpich/mpich2-1.0.3
+  make
+  make install
+
+and the binary will be in bin/Gale.