INSTALL

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