1Note: This is not a complete distribution of ARPACK,
2this distribution of ARPACK, bundled with GEOGRAM,
3only contains the original FORTRAN sources converted to C using F2C.
4One can get the original full ARPACK distribution (with documentation,
5FORTRAN sources and example programs) from:
6http://www.caam.rice.edu/software/ARPACK/
7
8----------------------------------------------------------------------
9
101. You have successfully unbundled ARPACK and are now in the ARPACK
11   directory that was created for you.
12
132. Recent bug fixes are included in patch.tar.gz and ppatch.tar.gz
14   (only needed if you are using PARPACK also.)  If you have not
15   retrieved these files, please do so and place them in the
16   directory right above the current directory.  (They should
17   be in the same directory where arpack96.tar reside).
18   Use uncompress or gunzip to unzip the tar files, and use 'tar -xvf '
19   to unbundle these patches.  The source codes in these patches will
20   overwrite those contained in arpack96.tar and parpack96.tar.
21
223. Upon executing the 'ls | more ' command you should see
23
24      BLAS
25      DOCUMENTS
26      EXAMPLES
27      LAPACK
28      README
29      SRC
30      UTIL
31      Makefile
32      ARmake.inc
33      ARMAKES
34
35   The following entries are directories:
36
37      ARMAKES, BLAS, DOCUMENTS, EXAMPLES, LAPACK, SRC, UTIL
38
39   The directory SRC contains the top level routines including
40   the highest level reverse communication interface routines
41
42      ssaupd, dsaupd - symmetric single and double precision
43      snaupd, dnaupd - non-symmetric single and double precision
44      cnaupd, cnaupd - complex non-symmetric single and double precision
45
46   The headers of these routines contain full documentation of calling
47   sequence and usage.  Additional information is in the DOCUMENTS directory.
48
49
504. Example driver programs that illustrate all the computational modes,
51   data types and precisions may be found in the EXAMPLES directory.
52   Upon executing the 'ls EXAMPLES | more ' command you should see
53
54      BAND
55      COMPLEX
56      NONSYM
57      README
58      SIMPLE
59      SVD
60      SYM
61
62   Example programs for banded, complex, nonsymmetric, symmetric,
63   and singular value decomposition may be found in the directories
64   BAND, COMPLEX, NONSYM, SYM, SVD respectively.  Look at the README
65   file for further information.  To get started, get into the SIMPLE
66   directory to see example programs that illustrate the use of ARPACK in
67   the simplest modes of operation for the most commonly posed
68   standard eigenvalue problems.
69
70   The following instructions explain how to make the ARPACK library.
71
72
735. Before you can compile anything, you must first edit and correct the file
74   ARmake.inc. Sample ARmake.inc's can be found in the ARMAKES directory.
75   Edit "ARmake.inc" and change the definition "home" to the root of the
76   source tree (Top level of ARPACK directory)
77
78   The makefile is set up to build a self-contained library which includes
79   the needed BLAS 1/2/3 and LAPACK routines.  If you already have the
80   BLAS and LAPACK libraries installed on your system you might want to
81   change the definition of DIRS as indicated in the ARmake.inc file.
82
83   *** NOTE ***  Unless the LAPACK library on your system is version 2.0,
84   we strongly recommend that you install the LAPACK routines provided with
85   ARPACK. Note that the current LAPACK release is version 3.0; if you are
86   not sure which version of LAPACK is installed, pleaase compile and link
87   to the subset of LAPACK included with ARPACK.
88
89
906. You will also need to change the file "second.f" in the UTIL directory
91   to whatever is appropriate for timing on your system.  The "second" routine
92   provided works on most workstations.  If you are running on a Cray,
93   you can just edit the makefile in UTIL and take out the reference to
94  "second.o" to use the system second routine.
95
96
977. Do "make lib" in the current directory to build the standard library
98   "libarpack_$(PLAT).a"
99
1008. Within DOCUMENTS directory there are three files
101
102   ex-sym.doc
103   ex-nonsym.doc and
104   ex-complex.doc
105
106   for templates on how to invoke the computational modes of ARPACK.
107   Also look in the README file for explanations concerning the
108   other documents.
109
110
111   Danny Sorensen   at  sorensen@caam.rice.edu
112   Richard Lehoucq  at  rblehou@sandia.gov
113   Chao Yang        at  cyang@lbl.gov
114   Kristi Maschhoff at  kristyn@tera.com
115
116If you have questions regarding using ARPACK, please send email
117to arpack@caam.rice.edu.
118
119 Good luck and enjoy.
120
121