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.
  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 must
  17     install at least the corresponding version of Bioperl: since this
  18     is bioperl-network 1.5.2, bioperl 1.5.2 is required.
  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     To install using CPAN you will need a recent version (v1.8802 has
  37     been tested) of it and your prefer_installer conf set to 'MB':
  38
  39     >cpan
  40     cpan>o conf prefer_installer MB
  41     cpan>o conf commit
  42     cpan>q
  43
  44     Now find the name of the bioperl-network version you want:
  45
  46     >cpan
  47     cpan>d /bioperl-network/
  48     Database was generated on Mon, 20 Nov 2006 05:24:36 GMT
  49     Distribution S/SE/SENDU/bioperl-network-1.5.2_100.tar.gz
  50
  51     Now install:
  52
  53     cpan>install S/SE/SENDU/bioperl-network-1.5.2_100.tar.gz
  54
  55     If you've installed everything perfectly then you may pass all the tests
  56     run in the './Build test' phase.
  57     It's also possible that you may fail some tests. Possible explanations:
  58     problems with local Perl installation, previously undetected bug in
  59     Bioperl, flawed test script and so on. A few failed tests may not affect
  60     your usage of bioperl-network.
  61
  62     If you decide that the failed tests will not affect how you intend to use
  63     bioperl-network and you'd like to install anyway do:
  64
  65     cpan>force install S/SE/SENDU/bioperl-network-1.5.2_100.tar.gz
  66
  67     This is what most experienced Bioperl users would do. However, if you're
  68     concerned about a failed test and need assistance or advice then contact
  69     bioperl-l@bioperl.org.
  70
  71
  72         Manual installation:
  73     >gunzip bioperl-network-<release-version>.tar.gz
  74     >tar xvf bioperl-network-<release-version>.tar
  75     >cd bioperl-network
  76
  77     where <release-version> is the current release.
  78
  79     >perl Build.PL
  80
  81     You can run regression tests and install bioperl-network using the
  82     following commands:
  83
  84     >./Build test
  85     >./Build install
  86
  87
  88     You may have to have root privileges in order to run './Build install'
  89     successfully on Unix. See the BioPerl INSTALL file for alternative approaches
  90     if you don't have root or administrative privileges.
  91
  92
  93 3. Installing bioperl-network (Windows and ActiveState Perl)
  94
  95     The following page on the BioPerl website has up-to-date
  96     instructions on how to install bioperl-network on Windows:
  97
  98     http://www.bioperl.org/wiki/Installing_Bioperl_on_Windows
  99
 100     (the instructions are aimed at bioperl-core, but apply
 101     equally to bioperl-network)