Fix docs for water/needle, match more recent versions of EMBOSS
[bioperl-run.git] / INSTALL
blob1235b33b6b59bbc785ca494cbfa50e242c4ac3e2
1 bioperl-run INSTALLATION
3 INSTALL THE RIGHT BIOPERL
5 You need at least the corresponding version of Bioperl. Since this
6 is BioPerl-run 1.007001, you should use BioPerl 1.007001.
9 INSTALLATION
11 Installation instructions at the following address apply here:
12 http://bioperl.org/INSTALL.html
13 The next 2 sections summarize the essential points from there.
16 CPAN INSTALLATION
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':
21   >cpan
22   cpan>o conf prefer_installer MB
23   cpan>o conf commit
24   cpan>q
26 Find the name of the bioperl-run version you want:
28   >cpan
29   cpan>d /bioperl-run/
30   Database was generated on Mon, 20 Nov 2006 05:24:36 GMT
31   Distribution CJFIELDS/BioPerl-Run-1.007001.tar.gz
33 Now install:
35  cpan>install CJFIELDS/BioPerl-Run-1.007001.tar.gz
37 If you've installed everything perfectly then you may pass all the tests
38 run in the './Build test' phase.
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.
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:
48  cpan>force install CJFIELDS/BioPerl-Run-1.007001.tar.gz
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.
54 MANUAL INSTALLATION
56 Download the bioperl-run archive, then extract its contents. Example:
58   >gunzip bioperl-run-<release-version>.tar.gz
59   >tar xvf bioperl-run-<release-version>.tar
60   >cd bioperl-run
62 where <release-version> is the current release.
64 Issue the following command from within bioperl-run/:
66   >perl Build.PL
68 You can run regression tests and install bioperl-run using the
69 following commands:
71   >./Build test
72   >./Build install
74 NOTE: many tests will be skipped without the necessary environment
75 variables set to tell Bioperl where your programs are installed.
77 INSTALLING bioperl-run ON WINDOWS
79 The following page on the BioPerl website has up-to-date
80 instructions on how to install bioperl-run on Windows:
82 http://www.bioperl.org/wiki/Installing_Bioperl_on_Windows
84 (the instructions are aimed at bioperl-core, but apply
85 equally to bioperl-run)