jpayne@69: -=- MUMmer3.x INSTALLATION README -=- jpayne@69: jpayne@69: -- TO INSTALL -- jpayne@69: Extract the tarfile by typing: jpayne@69: jpayne@69: "tar -xvzf MUMmer3.x" jpayne@69: jpayne@69: After extracting the tarfile into the desired installation directory, jpayne@69: change to the "MUMmer3.x" directory. Once in this directory, type: jpayne@69: jpayne@69: "make check" jpayne@69: jpayne@69: This command will check for the necessary utilities that the MUMmer package jpayne@69: depends on. If you see no error messages, the check was successful. Next, type: jpayne@69: jpayne@69: "make install" jpayne@69: jpayne@69: This command will build the appropriate scripts and binaries in the current jpayne@69: directory. Refer to the "README" file in this directory for further assistance, jpayne@69: or the "docs" directory for detailed information on the various utilities. jpayne@69: To make all of the scripts and executables accessible from different jpayne@69: directories, simply add the full MUMmer directory path to your system PATH, or jpayne@69: link the desired MUMmer programs to your favorite bin directory. Please note jpayne@69: that the 'make' command dynamically generates the MUMmer scripts with the jpayne@69: appropriate paths, therefore if the MUMmer directory is moved after the 'make' jpayne@69: command is issued, the scripts will fail to run. If the MUMmer executables jpayne@69: are needed in a directory other than the install directory, it is recommended jpayne@69: that the install directory be left untouched and its files linked to the jpayne@69: desired destination. An alternative would be to move the install directory and jpayne@69: reissue the 'make' command at the new location. jpayne@69: jpayne@69: jpayne@69: jpayne@69: -- SYSTEM REQUIREMENTS -- jpayne@69: MUMmer3.10 has been tested successfully on: jpayne@69: jpayne@69: - Redhat Linux 6.2, 7.3 (Pentium 4) jpayne@69: - Compaq Tru64 UNIX 5.1 (alpha) jpayne@69: - SunOS UNIX 5.8 (sparc) jpayne@69: - Mac OS X 10.2.8 (PowerPC G4) jpayne@69: jpayne@69: Sufficient memory and disk space are necessary, but required sizes vary jpayne@69: with input size. Be aware of your disk and memory usage, because insufficient jpayne@69: capacities will result in incorrect or missing output. Required resources jpayne@69: differ depending on the input size, but in general 512 MB of RAM and 1 GB of jpayne@69: disk space is sufficient for most applications. jpayne@69: It is possible to port the code to any system with a C++ compiler but jpayne@69: this has not been tested and will not be supported. In addition, you may need jpayne@69: to alter the Makefile to direct 'make' to your native compiler and other jpayne@69: system resources. jpayne@69: For Mac OSX, the Mac development kit must be downloaded and installed. This jpayne@69: kit will include 'gcc', 'ar', and 'make' which are necessary for building jpayne@69: MUMmer. MUMmer is not supported for any Mac operating system other than OSX. jpayne@69: jpayne@69: jpayne@69: jpayne@69: -- SOFTWARE REQUIREMENTS -- jpayne@69: The MUMmer3.x package requires the following to run successfully. In the jpayne@69: absence of one or more of these utilities, certain MUMmer programs may fail jpayne@69: to run correctly. Listed in parenthesis are the versions used to test the jpayne@69: MUMmer package. These versions, or subsequent versions should assure the proper jpayne@69: execution of the various MUMmer programs. These utilities must be accessible jpayne@69: via the system path: jpayne@69: jpayne@69: - make (GNU make 3.79.1) jpayne@69: - perl (PERL 5.6.0) jpayne@69: - sh (GNU sh 1.14.7) jpayne@69: - csh (tcsh 6.10.00) jpayne@69: - g++ (GNU gcc 2.95.3) jpayne@69: - sed (GNU sed 3.02) jpayne@69: - awk (GNU awk 3.0.4) jpayne@69: - ar (GNU ar 2.9.5) jpayne@69: jpayne@69: jpayne@69: -- OPTIONAL UTILITIES -- jpayne@69: To use the visualization tools included with MUMmer, it may be necessary jpayne@69: to download and install the following utilities: jpayne@69: jpayne@69: - fig2dev (fig2dev 3.2.3) jpayne@69: - gnuplot (gnuplot 4.0) jpayne@69: - xfig (xfig 3.2) jpayne@69: jpayne@69: jpayne@69: jpayne@69: -- UN-INSTALLATION -- jpayne@69: In the "MUMmer3.x" base directory type: jpayne@69: jpayne@69: "make uninstall" jpayne@69: jpayne@69: This will remove all binary executables and runnable scripts from the jpayne@69: base and aux_bin directories. The original source files will remain unchanged, jpayne@69: thus reverting the package to its post-untar, pre-install state. jpayne@69: jpayne@69: Please address questions and bug reports to: jpayne@69: jpayne@69: Last update: May 12, 2005