INSTALL

   1 $Id$
   2
   3 bioperl-network Installation
   4
   5 1. Requirements
   6 2. Installing bioperl-network (Unix or Cygwin)
   7 3. Installing bioperl-network (Windows and ActiveState Perl)
   8
   9
  10 1. Requirements
  11
  12    Perl 5.6.1 is required, but 5.8 or greater is recommended.
  13
  14         The bioperl-network package depends on the core BioPerl package. See
  15         http://www.bioperl.org/wiki/Getting_BioPerl or the BioPerl INSTALL file
  16    for instructions for downloading and installing BioPerl. You should
  17    install at least the corresponding version of Bioperl: since this
  18    is bioperl-network 1.6, bioperl 1.6 or greater is recommended.
  19
  20    bioperl-network also depends on Perl's Graph package. See CPAN at
  21    www.perl.org for instructions on downloading and installing Graph,
  22    use Graph version .86 or greater.
  23
  24    Reading PSI XML files using bioperl-network requires the XML::Twig
  25    module. See CPAN at www.perl.org for instructions on downloading
  26    and installing XML::Twig.
  27
  28
  29 2. Installing bioperl-network (Unix, Mac OS X and Cygwin)
  30
  31    Installation instructions at the following address apply here:
  32    http://www.bioperl.org/wiki/Installing_Bioperl_for_Unix
  33    The following sections summarize the essential points from there.
  34
  35    Using CPAN:
  36
  37    To install using CPAN you will need a recent version (v1.8802 has
  38    been tested) of it and your prefer_installer conf set to 'MB':
  39
  40     >cpan
  41     cpan>o conf prefer_installer MB
  42     cpan>o conf commit
  43     cpan>q
  44
  45    Now find the name of the bioperl-network version you want:
  46
  47     >cpan
  48     cpan>d /bioperl-network/
  49     Database was generated on Mon, 20 Nov 2006 05:24:36 GMT
  50     Distribution C/CJ/CJFIELDS/bioperl-network-1.006000.tar.gz
  51
  52    Now install:
  53
  54     cpan>install C/CJ/CJFIELDS/bioperl-network-1.006000.tar.gz
  55
  56    If you've installed everything perfectly then you may pass all the tests
  57    run in the './Build test' phase.
  58    It's also possible that you may fail some tests. Possible explanations:
  59    problems with local Perl installation, previously undetected bug in
  60    Bioperl, flawed test script and so on. A few failed tests may not affect
  61    your usage of bioperl-network.
  62
  63    If you decide that the failed tests will not affect how you intend to use
  64    bioperl-network and you'd like to install anyway do:
  65
  66     cpan>force C/CJ/CJFIELDS/bioperl-network-1.006000.tar.gz
  67
  68    This is what most experienced Bioperl users would do. However, if you're
  69    concerned about a failed test and need assistance or advice then contact
  70    bioperl-l@bioperl.org.
  71
  72
  73         Manual installation:
  74
  75     >gunzip bioperl-network-<release-version>.tar.gz
  76     >tar xvf bioperl-network-<release-version>.tar
  77     >cd bioperl-network
  78
  79    where <release-version> is the current release.
  80
  81     >perl Build.PL
  82
  83    You can run regression tests and install bioperl-network using the
  84    following commands:
  85
  86     >./Build test
  87     >./Build install
  88
  89    You may have to have root privileges in order to run './Build install'
  90    successfully on Unix. See the BioPerl INSTALL file for alternative approaches
  91    if you don't have root or administrative privileges.
  92
  93
  94 3. Installing bioperl-network (Windows and ActiveState Perl)
  95
  96    The following page on the BioPerl website has up-to-date
  97    instructions on how to install bioperl-network on Windows:
  98
  99     http://www.bioperl.org/wiki/Installing_Bioperl_on_Windows
 100
 101    The instructions are aimed at bioperl-core, but apply
 102    equally to bioperl-network.