binaries/src/mafft/readme

   1 -----------------------------------------------------------------------
   2   MAFFT: a multiple sequence alignment program
   3   version 6.713beta, 2009/09/24
   4
   5   http://align.bmr.kyushu-u.ac.jp/mafft/software/
   6   katoh@bioreg.kyushu-u.ac.jp
   7 -----------------------------------------------------------------------
   8
   9 1. COMPILE
  10      % cd core
  11      % make clean
  12      % make
  13      % cd ..
  14
  15      If you have the './extensions' directory, which is for RNA alignments,
  16      % cd extensions
  17      % make clean
  18      % make
  19      % cd ..
  20
  21
  22 2. INSTALL (select one procedure from 2a, 2b and 2c)
  23 2a. Install as root
  24      # cd core
  25      # make install
  26      # cd ..
  27
  28      If you have the './extensions' directory,
  29      # cd extensions
  30      # make install
  31      # cd ..
  32
  33      By this procedure (2a), programs are installed into
  34      /usr/local/bin/ and some binaries are installed into
  35      /usr/local/lib/mafft/.
  36
  37      If you want to install the binaries to a different directory
  38      than /usr/local/lib/mafft/, select either of the following
  39      two procedure (2b and 2c).
  40
  41 2b. Install without being root
  42      % cp ./binaries/* /somewhere/else/
  43
  44      In this case (2b), you *have to set* the MAFFT_BINARIES environment
  45      variable to point to the directory where the binaries are.
  46      % setenv MAFFT_BINARIES /somewhere/else/  # for csh, tcsh
  47      $ export MAFFT_BINARIES=/somewhere/else/  # for sh, bash
  48
  49 2c. Install without being root
  50      % cd core/
  51           Edit the first line of Makefile
  52           From:
  53           PREFIX = /usr/local
  54           To:
  55           PREFIX = /home/your_home/somewhere
  56      % make clean
  57      % make
  58      % make install
  59
  60      If you have the './extensions' directory,
  61      % cd extensions/
  62           Edit the first line of Makefile
  63           From:
  64           PREFIX = /usr/local
  65           To:
  66           PREFIX = /home/your_home/somewhere
  67      % make clean
  68      % make
  69      % make install
  70
  71      In this case (2c), the MAFFT_BINARIES environment variable
  72      *must not be* set.
  73
  74
  75 3. CHECK
  76      % cd test
  77      % rehash                                                   # if necessary
  78      % setenv MAFFT_BINARIES /where/binaries/were/installed     # if necessary
  79      % mafft sample > test.fftns2                               # FFT-NS-2
  80      % mafft --maxiterate 100  sample > test.fftnsi             # FFT-NS-i
  81      % mafft --globalpair sample > test.gins1                   # G-INS-1
  82      % mafft --globalpair --maxiterate 100  sample > test.ginsi # G-INS-i
  83      % mafft --localpair sample > test.lins1                    # L-INS-1
  84      % mafft --localpair --maxiterate 100  sample > test.linsi  # L-INS-i
  85      % diff test.fftns2 sample.fftns2
  86      % diff test.fftnsi sample.fftnsi
  87      % diff test.gins1 sample.gins1
  88      % diff test.ginsi sample.ginsi
  89      % diff test.lins1 sample.lins1
  90
  91      If you have the './extensions' directory,
  92      % mafft-qinsi samplerna > test.qinsi                       # Q-INS-i
  93      % mafft-xinsi samplerna > test.xinsi                       # X-INS-i
  94      % diff test.linsi sample.linsi
  95      % diff test.qinsi sample.qinsi
  96      % diff test.xinsi sample.xinsi
  97
  98
  99 4. INPUT FORMAT
 100      fasta format.
 101
 102      The type of input sequences (nucleotide or amino acid) is
 103      automatically recognized based on the frequency of A, T, G, C, U and N.
 104
 105
 106 5.  USAGE
 107      % /usr/local/bin/mafft input > output
 108
 109 See also http://align.bmr.kyushu-u.ac.jp/mafft/software/
 110
 111
 112 6. UNINSTALL
 113      # rm -r /usr/local/lib/mafft
 114      # rm /usr/local/bin/mafft
 115      # rm /usr/local/bin/fftns
 116      # rm /usr/local/bin/fftnsi
 117      # rm /usr/local/bin/nwns
 118      # rm /usr/local/bin/nwnsi
 119      # rm /usr/local/bin/linsi
 120      # rm /usr/local/bin/ginsi
 121      # rm /usr/local/bin/mafft-*
 122
 123
 124 7. LICENSE
 125      See the './license' file.
 126
 127      If you have the extensions, see the './license.extensions' file,