binaries/src/ViennaRNA/INSTALL

   1 Installation:
   2
   3 This package uses GNU autoconf generated configure scripts, see the
   4 file INSTALL.configure for generic configure documentation.
   5
   6 Quickstart: Usually you'll just have to type:
   7 ----------
   8         ./configure
   9         make
  10 and (as root)
  11         make install
  12
  13 Install Paths:
  14 -------------
  15 The main programs, library, man, and info pages are
  16 installed in the usual places by default
  17 (i.e. /usr/local/{bin,lib,man,info}). In addition the following
  18 install paths are used:
  19 header files    /usr/local/include/ViennaRNA    [includedir/ViennaRNA]
  20 parameter files /usr/local/share/ViennaRNA      [datadir/ViennaRNA]
  21 extra scripts   /usr/local/share/ViennaRNA/bin  [datadir/ViennaRNA/bin]
  22 documentation   /usr/local/share/ViennaRNA/doc  [datadir/ViennaRNA/doc]
  23
  24 All these locations can be changed by calling ./configure with
  25 appropriate options.
  26
  27 If you like having all software packages separated in their own directories
  28 you could run e.g.:
  29 ./configure --prefix=/opt/packages/ViennaRNA --datadir=/opt/packages/ViennaRNA
  30 resulting in /opt/packages/ViennaRNA/{bin,lib,man,info,include,doc} directories
  31
  32 The installed location of the Perl module is determined by Perl's own
  33 configuration, independent of any configure options.
  34 To leave out the Perl modules run
  35    ./configure --without-perl
  36
  37 The programs AnalyseSeqs and AnalyseDists offer some cluster analysis
  38 tools (split decomposition, statistical geometry, neighbor joining,
  39 Ward's method) for sequences and distance data. To also build these
  40 programs add  --with-cluster  to your configure options.
  41
  42 This release includes the RNAforester and Kinfold programs, which can also
  43 be obtained as independent packages. Running ./configure in the ViennaRNA
  44 directory will configure those two packages as well. However, for detailed
  45 information and compile time options, see the README and INSTALL files in
  46 the respective subdirectories.
  47
  48 The Kinfold program can be used to simulate the folding dynamics of an
  49 RNA molecule, and is compiled by default. Use the --without-kinfold
  50 option to skip compiling Kinfold.
  51
  52 The RNAforester program is used for comparing secondary structures using
  53 tree alignment. To compile RNAforester you'll need to first install the
  54 g2 graphic library, then run configure with the --with-forester option.
  55
  56 Calculation of partition functions (via RNAfold -p) uses double
  57 precision floats by default, to avoid overflow errors on longer sequences.
  58 If your machine has little memory and you dont't plan to fold sequences
  59 over 1000 bases in length you can compile the package to do the computions
  60 in single precision by giving ./configure the --enable-floatpf option.
  61
  62 Memory requirements for a sequence of length n will be approximately
  63 12*n^2 bytes for RNAfold -p in the double precision version, and
  64  4*n^2 bytes for the minimum free energy alone.
  65
  66
  67 The readseq program is not integrated in the build process. If desired,
  68 install readseq manually, following the instructions in the readseq
  69 directory.
  70
  71 There are man pages for all executables, the library is documented in
  72 ./doc/RNAlib-2.0.7.pdf as well as a set of HTML pages in
  73 ./doc/html/index.html. Documentation in HTML can also be found at
  74 http://www.tbi.univie.ac.at/~ivo/RNA/
  75
  76
  77 System specific notes:
  78
  79 MacOS X users:
  80
  81 Depending on your version of gcc (< 4.4 ?) it might be necessary to deactivate OpenMP support by passing the option
  82
  83 --disable-openmp
  84
  85 to the ./configure script, since the OpenMP support is only partial in earlier versions of gcc shipped for MacOS X.
  86
  87 Additionally, since MacOS X 10.5 the perl installation distributed with MacOS X seems to always include so called
  88 fat-binaries, i.e. binaries for multiple architecture types. Although this may be a nice portability feature of MacOS X
  89 it will break compilation of the perl interface to the RNAlib!
  90 To circumvent this problem you have two options
  91
  92 1. Compile the perl interface without fat-binary support. Do so by setting the global shell variable ARCHFLAGS to
  93 include only the target architecture used for compiling RNAlib. E.g. do the following before executing make
  94
  95 export ARCHFLAGS="-arch x86_64"
  96
  97 2. Compile the complete ViennaRNA package with fat-binary support. Therefore, run the ./configure script in the
  98 following manner
  99
 100 ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
 101             CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
 102             CPP="gcc -E" CXXCPP="g++ -E"
 103
 104 The second option is not guaranteed to produce a working result, thus we suggest using the first one to create a
 105 single architecture build of the RNAlib perl interface!
 106
 107 General remarks:
 108
 109 Calculating the partition function for long sequences ( >400 bases)
 110 generates a lot of floating point underflows. On some system this can slow
 111 down the calculation dramatically because an exception is invoked for each
 112 underflow. How to avoid this problem is highly system specific:
 113
 114 On SunOS 4.1 the remedy is calling nonstandard_arithmetic() add a -DSUN4 to
 115 the CFLAGS in lib/makefile to do this. Use CC=gcc since SUN's standard cc
 116 doesn't understand ANSI C.
 117
 118 On HP machines running hpux-9 or hpux-10 add -DHP9 to the CFLAGS so that
 119 fpsetfastmode() will be called.
 120
 121