← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/bioperl/gutsy

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: Bazaar Package Importer
  • Author(s): Matt Hope
  • Date: 2004-04-18 14:24:11 UTC
  • mfrom: (1.2.1 upstream) (2.1.1 warty)
  • Revision ID: james.westby@ubuntu.com-20040418142411-gr92uexquw4w8liq
Tags: 1.4-1
* New upstream release
* Examples and working code are installed by default to usr/bin,
  this has been moved to usr/share/doc/bioperl/bin

Show diffs side-by-side

added added

removed removed

Lines of Context:
INSTALL
1
 
# $Id: INSTALL,v 1.1.2.5 2002/03/18 03:22:37 jason Exp $
 
1
# $Id: INSTALL,v 1.28 2003/12/13 15:51:19 jason Exp $
2
2
 
3
3
Bioperl Install Directions
4
4
 
7
7
 - Tested on all common forms of Unix, Win9X/NT/2000, Mac OS X 
8
8
   (see the PLATFORMS file for more details)
9
9
 
10
 
 - perl 5.004 or later *.
 
10
 - perl 5.005 or later *.
11
11
 
12
12
 - ANSI C or Gnu C compiler for optional extra XS extensions 
13
13
 
20
20
   this process even easier.  Simply install the bundle in your CPAN
21
21
   shell and all necessary modules will be installed.
22
22
 
23
 
 - Bioperl on ActiveState for Windows - An ActiveState PPM distribution is
24
 
   available for bioperl.  Issue the following command in your PPM
25
 
   shell to install the Bioperl PPD.
26
 
   PPM> set repository Bioperl http://bioperl.org/DIST/
27
 
   PPM> install bioperl
 
23
 - Bioperl on ActiveState for Windows - An ActiveState PPM distribution
 
24
   is available for bioperl v. 1.0.  Issue the following commands in
 
25
   your PPM shell to install Bioperl (ActiveState Perl v. 5.6*).
 
26
 
 
27
     PPM>repository add Bioperl http://bioperl.org/DIST/
 
28
 
 
29
   Get the number of the Bioperl repository:
 
30
 
 
31
     PPM>repository
 
32
 
 
33
   Set the Bioperl repository, find Bioperl, install Bioperl:
 
34
 
 
35
     PPM>repository set <Bioperl repository number>
 
36
     PPM>search *
 
37
     PPM>install <bioperl package number>
 
38
  
 
39
   As of this writing the Bundle::BioPerl bundle is not found in any
 
40
   ActiveState package but the following command should work in 
 
41
   Command Prompt:
 
42
 
 
43
     >perl -MCPAN -e "install Bundle::BioPerl"
 
44
 
 
45
   Do not use a Unix make to install Perl modules this way, use nmake. 
 
46
   See "DEPENDENCIES AND Bundle::BioPerl" below for more information
 
47
   on this useful bundle.
28
48
 
29
49
 - Additional information using Bioperl with MacOS can be 
30
50
   found at http://bioperl.org/Core/mac-bioperl.html
53
73
   variables set.  If you do not have a local copy of the specific
54
74
   executeable you do not need to set these variables.  Additionally
55
75
   the modules will attempt to locate the specific applications in
56
 
   your runtime PATH variable.  
 
76
   your runtime PATH variable. You may also need to set an environment
 
77
   variable to tell BioPerl about your network configuration if your
 
78
   site uses a firewall.
57
79
 
58
80
   Setting environment variables on unix means adding a line like the
59
81
   following to your shell initialization:
81
103
   o TCOFFEEDIR - points to the directory where the t_coffee
82
104
                  executable is located.
83
105
                 
 
106
   o HTTP_PROXY - If you access the internet via a proxy server then you 
 
107
                  can tell the Bioperl modules which require network access
 
108
                  about this by using the HTTP_PROXY environment variable.  
 
109
                  The value set includes the proxy address and the port 
 
110
                  used (eg http://wwwcache.example.com:8080).
 
111
 
84
112
 
85
113
 * Note that most modules will work with earlier versions of Perl. 
86
114
   The only ones that will not are Bio::SimpleAlign.pm and 
131
159
 
132
160
 To install the Compiled extension for pSW you will need to read the
133
161
 next section of the manual.
 
162
 
134
163
 
135
164
 INSTALLING THE OPTIONAL COMPILED EXTENSIONS (bioperl-ext package)
136
165
 
167
196
 will work cleanly now.
168
197
 
169
198
 
 
199
 INSTALLING BIOPERL SCRIPTS
 
200
 
 
201
 Bioperl comes with a set of production-quality scripts that are kept
 
202
 in the scripts/ directory. You can install these scripts if you'd like,
 
203
 simply follow the instructions on 'make install'. The installation
 
204
 directory is specified by the INSTALLSCRIPT variable in the Makefile,
 
205
 the default location is /usr/bin. Installation will copy the scripts
 
206
 to the specified directory, change the 'PLS' suffix to 'pl', and
 
207
 prepend 'bp_' to all the script names if they aren't so named already.
 
208
 
 
209
 
170
210
 INSTALLING BIOPERL IN A PERSONAL OR PRIVATE MODULE AREA
171
211
 
172
212
 If you lack permission to install perl modules into the
182
222
 
183
223
 Example:
184
224
 
185
 
   perl Makefile.PL  PREFIX=/home/dag/My_Local_Perl_Modules
 
225
   perl Makefile.PL  LIB=/home/users/dag/My_Local_Perl_Modules
186
226
   make
187
227
   make test
188
228
   make install
189
229
 
190
 
 This will cause perl to install the bioperl modules in:
191
 
 /home/dag/My_Perl_Modules/lib/perl5/site_perl/
192
 
 
193
 
 And the bioperl man pages will go in:
194
 
 /home/dag/My_Perl_Modules/lib/perl5/man/
195
 
 
196
 
 To specify a directory besides lib/perl5/site_perl, 
197
 
 or if there are still permission problems, include
198
 
 an INSTALLSITELIB directive along with the PREFIX:
199
 
 
200
 
   perl Makefile.PL  PREFIX=/home/dag/perl INSTALLSITELIB=/home/dag/perl/lib
 
230
 This tells perl to install bioperl in the desired place, e.g.:
 
231
 
 
232
  /home/users/dag/My_Perl_Modules/Bio/Seq.pm
 
233
 
 
234
 Then in your Bioperl script you would write:
 
235
 
 
236
  use lib "/home/users/dag/My_Local_Perl_Modules";
 
237
  use Bio::Seq;
 
238
 
 
239
 The man pages will probably be installed in $LIB/man. For more
 
240
 information on these sorts of custom installs see the documentation
 
241
 for ExtUtils::MakeMaker.
201
242
 
202
243
 See below for how to use modules that are not installed in the
203
244
 standard Perl5 location.
204
245
 
 
246
 You can also use CPAN, as discussed below, to install accessory modules
 
247
 in your local directory. First enter the CPAN shell, 
 
248
 then set the arguments for the command "perl Makefile.PL":
 
249
 
 
250
 >perl -e shell -MCPAN
 
251
 cpan>o conf makepl_arg LIB=/home/users/dag/My_Local_Perl_Modules
 
252
 
205
253
 
206
254
 THE HARD WAY :)
207
255
 
248
296
 
249
297
    <...insert whizzy perl code here...>
250
298
 
251
 
THE TEST SYSTEM
 
299
 Or, you can set the environmental variable PERL5LIB:
 
300
 
 
301
    # csh or tcsh
 
302
    setenv PERL5LIB /home/users/dag/My_Local_Perl_Modules/
 
303
    # bash
 
304
    export PERL5LIB=/home/users/dag/My_Local_Perl_Modules/
 
305
 
 
306
 
 
307
 THE TEST SYSTEM
252
308
 
253
309
 The Bioperl test system is located in the t/ directory and is
254
310
 automatically run whenever you execute the 'make test' command.
270
326
 detects that the network is not present and thus should skip, not
271
327
 fail, any tests that require a network connection.
272
328
 
273
 
DEPENDANCIES
274
 
 
275
 
The following packages are used by Bioperl.  Not all are required for
276
 
Bioperl to operate properly, however, some functionality will be
277
 
missing without them.  You can easily install all of these via the
278
 
Bundle::BioPerl CPAN bundle.
279
 
 
280
 
Module                   Where it is Used
281
 
------------------------------------------------------------------
282
 
HTTP::Request::Common    GenBank+GenPept sequence retrieval, 
283
 
                         remote http Blast jobs.
284
 
                         Bio::DB::*,Bio::Tools::Run::RemoteBlast
285
 
 
286
 
LWP::UserAgent           GenBank+GenPept sequence retrieval, 
287
 
                         remote http Blast jobs
288
 
                         Bio::DB::*,Bio::Tools::Run::RemoteBlast
289
 
 
290
 
Ace come from AcePerl    Access to ACeDB databases
291
 
                         Bio::DB::Ace
292
 
 
293
 
IO::Scalar               IO handle to read or write to a scalar/remote 
294
 
                         http Blast jobs
295
 
                         Bio::Tools::Blast::Run::Remote,
296
 
 
297
 
IO::String               IO handle to read or write to a string.
298
 
                         GenBank+GenPept sequence retrieval, 
299
 
                         Variation code,
300
 
                         Bio::DB::*,Bio::Variation::*,
301
 
                         Bio::Index::Blast
302
 
 
303
 
XML::Parser              Parsing of XML documents
304
 
                         Bio::Variation code, GAME parser, SearchIO
305
 
                         Bio::SeqIO::game,Bio::Variation::*, 
306
 
                         Bio::SearchIO::blastxml
307
 
                         Bio::Biblio::IO::medlinexml
308
 
 
309
 
XML::Writer              Parsing + writing of XML documents
310
 
                         Bio::Variation code, GAME parser
311
 
                         Bio::SeqIO::game,Bio::Variation::*
312
 
 
313
 
XML::Parser::PerlSAX     Parsing of XML documents
314
 
                         Bio::Variation code, GAME parser, SearchIO
315
 
                         Bio::SeqIO::game,Bio::Variation::*,
316
 
                         Bio::SearchIO::blastxml
317
 
                         Bio::Biblio::IO::medlinexml
318
 
 
319
 
XML::Twig                Pxarsing of XML documents
320
 
                         Module Bio::Variation::IO::xml.pm
321
 
 
322
 
File::Temp               Temporary File creation
323
 
                         Bio::DB::WebDBSeqI, Bio::Seq::LargePrimarySeq
324
 
                         All analysis running
325
 
 
326
 
SOAP::Lite               SOAP protocol
327
 
                         XEMBL Services, 
328
 
                         Bibliographic queries in Biblio::
329
 
                         Bio::DB::XEMBLService
330
 
 
331
 
HTML::Parser             HTML parsing of GDB page
332
 
                         Bio::DB::GDB
333
 
 
334
 
DBD::mysql               Mysql driver
335
 
                         loading and querying of Mysql-based 
336
 
                         GFF feature databases
337
 
                         Bio::DB::GFF
338
 
 
339
 
GD                       GD graphical drawing library
340
 
                         Bio::Graphics
341
 
 
342
 
srsperl.pm               Sequence Retrieval System (SRS) 
343
 
                         alternative way of retrieving 
344
 
                         sequences
345
 
                         Bio::LiveSeq::IO::SRS.pm
346
 
                         See README in Bio/LiveSeq/IO
347
 
Storable                 Persistent object storage & retrieval 
348
 
                         Bio::DB::FileCache
349
 
 
350
 
 
 
329
 
 
330
 DEPENDENCIES AND Bundle::BioPerl
 
331
 
 
332
 The following packages are used by Bioperl.  Not all are required for
 
333
 Bioperl to operate properly, however, some functionality will be
 
334
 missing without them.  You can easily install all of these, except
 
335
 srsperl.pm, using the Bundle::BioPerl CPAN bundle. A command-line
 
336
 example:
 
337
 
 
338
  >perl -e shell -MCPAN
 
339
  cpan>install Bundle::BioPerl
 
340
  <...installation details...>
 
341
  cpan>quit
 
342
 
 
343
 or more simply:
 
344
 
 
345
  >perl -MCPAN -e "install Bundle::BioPerl"
 
346
 
 
347
 The DBD::mysql, DB_File and XML::Parser modules require other
 
348
 applications or databases: MySQL, Berkeley DB, and expat respectively.
 
349
 
 
350
 Module                  Where it is Used
 
351
 ------------------------------------------------------------------
 
352
 HTTP::Request::Common    GenBank+GenPept sequence retrieval, 
 
353
                          remote http Blast jobs
 
354
                          Bio::DB::*
 
355
                          Bio::Tools::Run::RemoteBlast
 
356
 
 
357
 LWP::UserAgent           GenBank+GenPept sequence retrieval, 
 
358
                          remote http Blast jobs
 
359
                          Bio::DB::*
 
360
                          Bio::Tools::Run::RemoteBlast
 
361
 
 
362
 AcePerl                  Access to ACeDB databases
 
363
                          Bio::DB::Ace
 
364
                          Available at http://stein.cshl.org
 
365
                         
 
366
 IO::String               IO handle to read or write to a string
 
367
                          Bio::SeqIO
 
368
                          Bio::Variation::*
 
369
                          Bio::DB::*
 
370
                          Bio::Index::Blast
 
371
                          Bio::Tools::*
 
372
                          Bio::Biblio::IO
 
373
                          Bio::Structure::IO
 
374
 
 
375
 XML::Parser              Parsing of XML documents
 
376
                          Bio::SeqIO::game
 
377
                          Bio::Variation::* 
 
378
                          Bio::SearchIO::blastxml
 
379
                          Bio::Biblio::IO::medlinexml
 
380
                          Requires expat from
 
381
                          http://sourceforge.net/projects/expat/
 
382
                                                 
 
383
 XML::Writer              Parsing + writing of XML documents
 
384
                          Bio::SeqIO::game
 
385
                          Bio::Variation::*
 
386
 
 
387
 XML::Parser::PerlSAX     Parsing of XML documents
 
388
                          Bio::SeqIO::game
 
389
                          Bio::Variation::*
 
390
                          Bio::SearchIO::blastxml
 
391
                          Bio::Biblio::IO::medlinexml
 
392
 
 
393
 XML::Twig                Parsing of XML documents
 
394
                          Bio::Variation::IO::xml
 
395
 
 
396
 File::Temp               Temporary File creation
 
397
                          Bio::DB::FileCache
 
398
                          Bio::DB::XEMBL
 
399
 
 
400
 SOAP::Lite               SOAP protocol, XEMBL Services
 
401
                          Bio::Biblio::*
 
402
                          Bio::DB::XEMBLService
 
403
 
 
404
 HTML::Parser             HTML parsing of GDB page
 
405
                          Bio::DB::GDB
 
406
 
 
407
 DBD::mysql               Mysql API for loading and querying of Mysql-based 
 
408
                          GFF feature and BioSQL databases
 
409
                          Bio::DB::GFF
 
410
                          bioperl-db external package
 
411
                          bioperl-pipeline external package
 
412
                          Mysql DB free from www.mysql.org
 
413
 
 
414
 GD                       GD graphical drawing library
 
415
                          Bio::Graphics
 
416
                          Requires GD library from www.boutell.com/gd
 
417
 
 
418
 srsperl                  Sequence Retrieval System (SRS) 
 
419
                          alternative way of retrieving 
 
420
                          sequences
 
421
                          Bio::LiveSeq::IO::SRS.pm
 
422
                          See README in Bio/LiveSeq/IO
 
423
 
 
424
 Storable                 Persistent object storage & retrieval 
 
425
                          Bio::DB::FileCache
 
426
 
 
427
 Text::Shellwords         Text parser
 
428
                          Bio::Graphics::FeatureFile
 
429
 
 
430
 XML::DOM                 XML parser
 
431
                          Bio::SeqIO::bsml.pm
 
432
 
 
433
 DB_File                  Perl access to Berkeley DB
 
434
                          Bio::DB::Flat
 
435
                          Bio::DB::Fasta,
 
436
                          Bio::SeqFeature::Collection,
 
437
                          Bio::Index::*
 
438
                          Requires Berkeley DB, from Linux RPM
 
439
                          or from www.sleepycat.com
 
440
 
 
441
 Graph::Directed          generic graph data and algorithms
 
442
                          Bio::Ontology::SimpleOntologyEngine
 
443
 
 
444
 Data::Stag::ITextWriter  Structured Tags datastructures
 
445
                          Bio::SeqIO::chadoitext
 
446
 
 
447
 Data::Stag::SxprWriter   Structured Tags datastructures
 
448
                          Bio::SeqIO::chadosxpr
 
449
 
 
450
 Data::Stag::XMLWriter    Structured Tags datastructures
 
451
                          Bio::SeqIO::chadoxml
 
452
 Text::Wrap               (Very optional)
 
453
                          Bio::SearchIO::Writer::TextResultWriter
 
454
 HTML::Entities           (only if you want to run webanalysis modules)
 
455
                          Bio::Tools::Analysis::DNA::*
 
456
                          Bio::Tools::Analysis::Protein::*