INSTALL

   1 # $Id$
   2
   3 bioperl-db INSTALLATION
   4
   5 INSTALL THE RIGHT BIOPERL
   6
   7 You need at least the corresponding version of Bioperl. Since this
   8 is bioperl-db 1.5.2, you will need bioperl 1.5.2.
   9
  10
  11 INSTALL BIOSQL
  12
  13 The bioperl-db package is designed to work with the BioSQL database.
  14 Install the BioSQL package by following the instructions in its
  15 INSTALL file. You can obtain the BioSQL package at www.open-bio.org.
  16 BioSQL requires a relational database, either Mysql, Oracle, or
  17 Postgres.
  18
  19
  20 CPAN INSTALLATION
  21
  22 To install using CPAN you will need a recent version (v1.8802 has
  23 been tested) of it and your prefer_installer conf set to 'MB':
  24
  25   >cpan
  26   cpan> o conf init prefer_installer
  27   Choose 'MB'.
  28   cpan> o conf commit
  29   cpan> q
  30
  31 Ensure that you have installed BioSQL properly prior to attempting
  32 an installation. You will also probably need root privileges.
  33 Find the name of the bioperl-db version you want:
  34
  35   >cpan
  36   cpan>d /bioperl-run/
  37   Database was generated on Mon, 20 Nov 2006 05:24:36 GMT
  38   Distribution S/SE/SENDU/bioperl-db-1.5.2_100.tar.gz
  39
  40 Now install:
  41
  42  cpan>install S/SE/SENDU/bioperl-db-1.5.2_100.tar.gz
  43
  44 If you've installed everything perfectly then you may pass all the tests
  45 run in the './Build test' phase.
  46 It's also possible that you may fail some tests. Possible explanations:
  47 problems with local Perl installation, previously undetected bug in
  48 Bioperl, flawed test script and so on. A few failed tests may not affect
  49 your usage of bioperl-db.
  50
  51 If you decide that the failed tests will not affect how you intend to use
  52 bioperl-db and you'd like to install anyway do:
  53
  54  cpan>force install S/SE/SENDU/bioperl-db-1.5.2_100.tar.gz
  55
  56 This is what most experienced Bioperl users would do. However, if you're
  57 concerned about a failed test and need assistance or advice then contact
  58 bioperl-l@bioperl.org.
  59
  60
  61 MANUAL INSTALLATION
  62
  63 Download the bioperl-db archive, then extract its contents. Example:
  64
  65   >gunzip bioperl-db-<release-version>.tar.gz
  66   >tar xvf bioperl-db-<release-version>.tar
  67   >cd bioperl-db
  68
  69 where <release-version> is the current release.
  70
  71 Copy or rename t/DBHarness.conf.example to t/DBHarness.biosql.conf
  72 and edit the file as needed. Then issue the following command from
  73 within bioperl-db/:
  74
  75   >perl Build.PL
  76
  77 You can run regression tests and install bioperl-db using the
  78 following commands:
  79
  80   >./Build test
  81   >./Build install
  82
  83 NOTE: bioperl-db tests require that the BioSQL database in
  84 DBHarness.biosql.conf does NOT have NCBI taxonomy loaded.  Also,
  85 the './Build  install' step may require that you have root privileges.
  86
  87
  88 INSTALLING bioperl-db ON WINDOWS
  89
  90 The following page on the BioPerl website has up-to-date
  91 instructions on how to install bioperl-db on Windows:
  92
  93 http://www.bioperl.org/wiki/Installing_Bioperl_on_Windows
  94
  95
  96 LOAD THE NCBI TAXONOMY
  97
  98 You should pre-load the NCBI taxonomy database using the
  99 scripts/load_ncbi_taxonomy.pl script in the BioSQL package.
 100 Otherwise you will see errors from mis-parsed organisms when you
 101 attempt to load sequences.
 102
 103
 104 LOAD SEQUENCE DATA
 105
 106 Most people will want to load sequence data into their BioSQL
 107 databases. Use scripts/biosql/load_seqdatabase.pl in the bioperl-db
 108 package to load sequences from sequence files. Do:
 109
 110   >perldoc scripts/biosql/load_seqdatabase.pl
 111
 112 or
 113
 114   >scripts/biosql/load_seqdatabase.pl --help
 115
 116 for more information.
 117
 118 This script has many options to flexibly deal with various update
 119 scenarios. Do read the POD before running an update.
 120
 121
 122 LOAD ONTOLOGIES
 123
 124 Use scripts/biosql/load_ontology.pl in the bioperl-db
 125 package to load ontologies from flat files. Do:
 126
 127   >perldoc scripts/biosql/load_ontology.pl
 128
 129 or
 130
 131   >scripts/biosql/load_ontology.pl --help
 132
 133 for more information.
 134
 135 This script has many options to flexibly deal with various update
 136 scenarios. Do read the POD before running an update. Also, some
 137 ontologies maintain obsoleted terms, for instance the Gene
 138 Ontology. Read the POD for possible options to deal with obsoleted
 139 terms; this is relevant even when you load the ontology the first
 140 time, as you may choose to keep obsoleted terms out of the database
 141 from the start.
 142
 143
 144 FEEDBACK
 145
 146 Write down any problems or praise and send them to
 147 bioperl-l@bioperl.org  ;-)
 148