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