|
jpayne@69
|
1 -=- MUMmer3.x INSTALLATION README -=-
|
|
jpayne@69
|
2
|
|
jpayne@69
|
3 -- TO INSTALL --
|
|
jpayne@69
|
4 Extract the tarfile by typing:
|
|
jpayne@69
|
5
|
|
jpayne@69
|
6 "tar -xvzf MUMmer3.x"
|
|
jpayne@69
|
7
|
|
jpayne@69
|
8 After extracting the tarfile into the desired installation directory,
|
|
jpayne@69
|
9 change to the "MUMmer3.x" directory. Once in this directory, type:
|
|
jpayne@69
|
10
|
|
jpayne@69
|
11 "make check"
|
|
jpayne@69
|
12
|
|
jpayne@69
|
13 This command will check for the necessary utilities that the MUMmer package
|
|
jpayne@69
|
14 depends on. If you see no error messages, the check was successful. Next, type:
|
|
jpayne@69
|
15
|
|
jpayne@69
|
16 "make install"
|
|
jpayne@69
|
17
|
|
jpayne@69
|
18 This command will build the appropriate scripts and binaries in the current
|
|
jpayne@69
|
19 directory. Refer to the "README" file in this directory for further assistance,
|
|
jpayne@69
|
20 or the "docs" directory for detailed information on the various utilities.
|
|
jpayne@69
|
21 To make all of the scripts and executables accessible from different
|
|
jpayne@69
|
22 directories, simply add the full MUMmer directory path to your system PATH, or
|
|
jpayne@69
|
23 link the desired MUMmer programs to your favorite bin directory. Please note
|
|
jpayne@69
|
24 that the 'make' command dynamically generates the MUMmer scripts with the
|
|
jpayne@69
|
25 appropriate paths, therefore if the MUMmer directory is moved after the 'make'
|
|
jpayne@69
|
26 command is issued, the scripts will fail to run. If the MUMmer executables
|
|
jpayne@69
|
27 are needed in a directory other than the install directory, it is recommended
|
|
jpayne@69
|
28 that the install directory be left untouched and its files linked to the
|
|
jpayne@69
|
29 desired destination. An alternative would be to move the install directory and
|
|
jpayne@69
|
30 reissue the 'make' command at the new location.
|
|
jpayne@69
|
31
|
|
jpayne@69
|
32
|
|
jpayne@69
|
33
|
|
jpayne@69
|
34 -- SYSTEM REQUIREMENTS --
|
|
jpayne@69
|
35 MUMmer3.10 has been tested successfully on:
|
|
jpayne@69
|
36
|
|
jpayne@69
|
37 - Redhat Linux 6.2, 7.3 (Pentium 4)
|
|
jpayne@69
|
38 - Compaq Tru64 UNIX 5.1 (alpha)
|
|
jpayne@69
|
39 - SunOS UNIX 5.8 (sparc)
|
|
jpayne@69
|
40 - Mac OS X 10.2.8 (PowerPC G4)
|
|
jpayne@69
|
41
|
|
jpayne@69
|
42 Sufficient memory and disk space are necessary, but required sizes vary
|
|
jpayne@69
|
43 with input size. Be aware of your disk and memory usage, because insufficient
|
|
jpayne@69
|
44 capacities will result in incorrect or missing output. Required resources
|
|
jpayne@69
|
45 differ depending on the input size, but in general 512 MB of RAM and 1 GB of
|
|
jpayne@69
|
46 disk space is sufficient for most applications.
|
|
jpayne@69
|
47 It is possible to port the code to any system with a C++ compiler but
|
|
jpayne@69
|
48 this has not been tested and will not be supported. In addition, you may need
|
|
jpayne@69
|
49 to alter the Makefile to direct 'make' to your native compiler and other
|
|
jpayne@69
|
50 system resources.
|
|
jpayne@69
|
51 For Mac OSX, the Mac development kit must be downloaded and installed. This
|
|
jpayne@69
|
52 kit will include 'gcc', 'ar', and 'make' which are necessary for building
|
|
jpayne@69
|
53 MUMmer. MUMmer is not supported for any Mac operating system other than OSX.
|
|
jpayne@69
|
54
|
|
jpayne@69
|
55
|
|
jpayne@69
|
56
|
|
jpayne@69
|
57 -- SOFTWARE REQUIREMENTS --
|
|
jpayne@69
|
58 The MUMmer3.x package requires the following to run successfully. In the
|
|
jpayne@69
|
59 absence of one or more of these utilities, certain MUMmer programs may fail
|
|
jpayne@69
|
60 to run correctly. Listed in parenthesis are the versions used to test the
|
|
jpayne@69
|
61 MUMmer package. These versions, or subsequent versions should assure the proper
|
|
jpayne@69
|
62 execution of the various MUMmer programs. These utilities must be accessible
|
|
jpayne@69
|
63 via the system path:
|
|
jpayne@69
|
64
|
|
jpayne@69
|
65 - make (GNU make 3.79.1)
|
|
jpayne@69
|
66 - perl (PERL 5.6.0)
|
|
jpayne@69
|
67 - sh (GNU sh 1.14.7)
|
|
jpayne@69
|
68 - csh (tcsh 6.10.00)
|
|
jpayne@69
|
69 - g++ (GNU gcc 2.95.3)
|
|
jpayne@69
|
70 - sed (GNU sed 3.02)
|
|
jpayne@69
|
71 - awk (GNU awk 3.0.4)
|
|
jpayne@69
|
72 - ar (GNU ar 2.9.5)
|
|
jpayne@69
|
73
|
|
jpayne@69
|
74
|
|
jpayne@69
|
75 -- OPTIONAL UTILITIES --
|
|
jpayne@69
|
76 To use the visualization tools included with MUMmer, it may be necessary
|
|
jpayne@69
|
77 to download and install the following utilities:
|
|
jpayne@69
|
78
|
|
jpayne@69
|
79 - fig2dev (fig2dev 3.2.3)
|
|
jpayne@69
|
80 - gnuplot (gnuplot 4.0)
|
|
jpayne@69
|
81 - xfig (xfig 3.2)
|
|
jpayne@69
|
82
|
|
jpayne@69
|
83
|
|
jpayne@69
|
84
|
|
jpayne@69
|
85 -- UN-INSTALLATION --
|
|
jpayne@69
|
86 In the "MUMmer3.x" base directory type:
|
|
jpayne@69
|
87
|
|
jpayne@69
|
88 "make uninstall"
|
|
jpayne@69
|
89
|
|
jpayne@69
|
90 This will remove all binary executables and runnable scripts from the
|
|
jpayne@69
|
91 base and aux_bin directories. The original source files will remain unchanged,
|
|
jpayne@69
|
92 thus reverting the package to its post-untar, pre-install state.
|
|
jpayne@69
|
93
|
|
jpayne@69
|
94 Please address questions and bug reports to: <mummer-help@lists.sourceforge.net>
|
|
jpayne@69
|
95
|
|
jpayne@69
|
96 Last update: May 12, 2005
|
