INSTALL

   1 # $Id$
   2
   3 bioperl-run INSTALLATION
   4
   5
   6 INSTALL THE RIGHT BIOPERL
   7
   8 You need at least the corresponding version of Bioperl. Since this
   9 is bioperl-run 1.5.2, you will need bioperl 1.5.2.
  10
  11
  12 INSTALLATION
  13
  14 Installation instructions at the following address apply here:
  15 http://www.bioperl.org/wiki/Installing_Bioperl_for_Unix
  16 The next 2 sections summarize the essential points from there.
  17
  18
  19 CPAN INSTALLATION
  20
  21 To install using CPAN you will need a recent version (v1.8802 has
  22 been tested) of it and your prefer_installer conf set to 'MB':
  23
  24   >cpan
  25   cpan>o conf prefer_installer MB
  26   cpan>o conf commit
  27   cpan>q
  28
  29 Find the name of the bioperl-run version you want:
  30
  31   >cpan
  32   cpan>d /bioperl-run/
  33   Database was generated on Mon, 20 Nov 2006 05:24:36 GMT
  34   Distribution S/SE/SENDU/bioperl-run-1.5.2_100.tar.gz
  35
  36 Now install:
  37
  38  cpan>install S/SE/SENDU/bioperl-run-1.5.2_100.tar.gz
  39
  40 If you've installed everything perfectly then you may pass all the tests
  41 run in the './Build test' phase.
  42 It's also possible that you may fail some tests. Possible explanations:
  43 problems with local Perl installation, previously undetected bug in
  44 Bioperl, flawed test script and so on. A few failed tests may not affect
  45 your usage of bioperl-run.
  46
  47 If you decide that the failed tests will not affect how you intend to use
  48 bioperl-run and you'd like to install anyway do:
  49
  50  cpan>force install S/SE/SENDU/bioperl-run-1.5.2_100.tar.gz
  51
  52 This is what most experienced Bioperl users would do. However, if you're
  53 concerned about a failed test and need assistance or advice then contact
  54 bioperl-l@bioperl.org.
  55
  56
  57 MANUAL INSTALLATION
  58
  59 Download the bioperl-run archive, then extract its contents. Example:
  60
  61   >gunzip bioperl-run-<release-version>.tar.gz
  62   >tar xvf bioperl-run-<release-version>.tar
  63   >cd bioperl-run
  64
  65 where <release-version> is the current release.
  66
  67 Issue the following command from within bioperl-run/:
  68
  69   >perl Build.PL
  70
  71 You can run regression tests and install bioperl-run using the
  72 following commands:
  73
  74   >./Build test
  75   >./Build install
  76
  77 NOTE: many tests will be skipped without the necessary environment
  78 variables set to tell Bioperl where your programs are installed.
  79
  80
  81 INSTALLING bioperl-run ON WINDOWS
  82
  83 The following page on the BioPerl website has up-to-date
  84 instructions on how to install bioperl-run on Windows:
  85
  86 http://www.bioperl.org/wiki/Installing_Bioperl_on_Windows
  87
  88 (the instructions are aimed at bioperl-core, but apply
  89 equally to bioperl-run)
  90
  91
  92 ENVIRONMENT VARIABLES
  93
  94  Some important environment variables you need to be aware of.
  95
  96  Variable               Values     Comment
  97  --------------------------------------------------------------------
  98  PHYLIPVERSION  3.5, 3.6   If you want to run Phylip3.6 you
  99                            need to set this env variable to 3.6
 100
 101  BLASTDIR               DIR PATH   Point to the directory where BLAST
 102                                is installed
 103
 104  GENSCAN_DIR    DIR PATH   Point to the directory where
 105                            HumanIso.smat file is installed
 106
 107  EPONINEDIR     DIR PATH   Point to the directory where
 108                            eponine_scan.jar is installed
 109
 110  PAMLDIR        DIR PATH   Point to directory where PAML is
 111                            installed
 112
 113 Generally the all-caps program name concatenated to 'DIR' patten for
 114 environment variable names is followed for most programs. However
 115 there are some exceptions (some require an underscore between the
 116 program name and 'DIR'), so check the documentation for the module
 117 you're interested in using.
 118
 119 Note that for some programs, having the executables in your path is
 120 not enough - the correct environment variable still needs to be set,
 121 and sometimes it shouldn't point to the executable location, but
 122 somewhere else - again, check the documentation.