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