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