INSTALL

   1 # $Id$
   2
   3 bioperl-db INSTALLATION
   4
   5 INSTALL THE RIGHT BIOPERL
   6
   7 You need at least Bioperl version 1.4* but 1.4 has a problem
   8 in the ontology IO code for parsing GO, version 1.5* is preferable.
   9 Versions earlier than 1.4 will not work. See http://bioperl.org
  10 for instructions.
  11
  12
  13 INSTALL BIOSQL
  14
  15 The bioperl-db package is designed to work with the BioSQL database.
  16 Install the BioSQL package by following the instructions in its
  17 INSTALL file. You can obtain the BioSQL package at www.open-bio.org.
  18 BioSQL requires a relational database, either Mysql, Oracle, or
  19 Postgres.
  20
  21
  22 MAKE
  23
  24 Download the bioperl-db archive, then extract its contents. Example:
  25
  26   >gunzip bioperl-db-<release-version>.tar.gz
  27   >tar xvf bioperl-db-<release-version>.tar
  28   >cd bioperl-db
  29
  30 where <release-version> is the current release. Note that at present
  31 there is no versioned release and you will need to download bioperl-db
  32 through CVS.
  33
  34 If you are on Windows, see the respective section at the end of this
  35 document.
  36
  37 Otherwise, copy or rename t/DBHarness.conf.example to
  38 t/DBHarness.biosql.conf and edit the file as needed. Then issue the
  39 following commands from within bioperl-db/:
  40
  41   >perl Makefile.PL
  42   >make
  43   >make test
  44   >make install
  45
  46 The 'make install' step may require that you have root privileges.
  47
  48
  49 LOAD THE NCBI TAXONOMY
  50
  51 You should pre-load the NCBI taxonomy database using the
  52 scripts/load_ncbi_taxonomy.pl script in the BioSQL package.
  53 Otherwise you will see errors from mis-parsed organisms when you
  54 attempt to load sequences.
  55
  56
  57 LOAD SEQUENCE DATA
  58
  59 Most people will want to load sequence data into their BioSQL
  60 databases. Use scripts/biosql/load_seqdatabase.pl in the bioperl-db
  61 package to load sequences from sequence files. Do:
  62
  63   >perldoc scripts/biosql/load_seqdatabase.pl
  64
  65 or
  66
  67   >scripts/biosql/load_seqdatabase.pl --help
  68
  69 for more information.
  70
  71 This script has many options to flexibly deal with various update
  72 scenarios. Do read the POD before running an update.
  73
  74
  75 LOAD ONTOLOGIES
  76
  77 Use scripts/biosql/load_ontology.pl in the bioperl-db
  78 package to load ontologies from flat files. Do:
  79
  80   >perldoc scripts/biosql/load_ontology.pl
  81
  82 or
  83
  84   >scripts/biosql/load_ontology.pl --help
  85
  86 for more information.
  87
  88 This script has many options to flexibly deal with various update
  89 scenarios. Do read the POD before running an update. Also, some
  90 ontologies maintain obsoleted terms, for instance the Gene
  91 Ontology. Read the POD for possible options to deal with obsoleted
  92 terms; this is relevant even when you load the ontology the first
  93 time, as you may choose to keep obsoleted terms out of the database
  94 from the start.
  95
  96
  97 FEEDBACK
  98
  99 Write down any problems or praise and send them to
 100 bioperl-l@bioperl.org  ;-)
 101
 102
 103 INSTALLING bioperl-db ON WINDOWS
 104
 105 The following is a report sent by Chris Fields, cjfields at uiuc.edu.
 106 =========================================
 107 I have installed bioperl-db on Windows XP without a problem (although
 108 I plan on switching over to MacOSX within a year!).  Basically, here's
 109 what I did:
 110
 111 1) Install Activestate's free Perl package (the latest version of Perl 5.8).
 112
 113 2) Using PPM, install Bioperl.  There are installation instructions
 114    for this on the website.
 115
 116 3) Install your database of choice.  I installed MySQL (which has a
 117    Windows installer).
 118
 119 4) Install the database interface modules (DBI and DBD-MySQL, both
 120    available through PPM).  Adding Randy Kobe's repository in PPM
 121    helps here, although it isn't necessary (it does help if you want
 122    other modules for bioperl, like GD).
 123
 124 5) Get BioSQL schema.  Judging by the error, you may be missing this
 125    or bioperl-db (which operates with BioSQL).
 126
 127         a) Go to the CVS repository and download the bioperl-db
 128         package as tarball.
 129
 130         b) Decompress the tarball and view the installation
 131         instructions.  This will tell you where to get BioSQL (hint:
 132         it's in the same CVS repository as well as the CVS mentioned
 133         in the installation files).
 134
 135         c) Get the particular schema for your database.  This is
 136         located in biosql-schema/sql.
 137
 138 6) Install bioperl-db using nmake.  This worked well for me, although
 139    nmake is notoriously buggy sometimes.
 140
 141         a) Using a shell (or command prompt for Windows users),
 142         migrate to the bioperl-db folder (which you decompressed
 143         above).
 144
 145         b)  Type the following:
 146
 147                 perl Makefile.PL
 148                 nmake
 149                 nmake install
 150
 151         c) You might get some errors here with nmake.  Don't panic
 152         (and remember your towel).  Okay, bad Douglas Adams humor...
 153
 154         d)  You don't have nmake?!?  get the old nmake here:
 155
 156 http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/Nmake15.exe
 157
 158         e) nmake also comes with MSVC++.  You don't have MSVC++?!?
 159         Don't panic yet, because...
 160
 161         f) I've heard reports that make also works (using MinGW or
 162         other windows-ported tools), but I haven't tried these, so be
 163         warned.
 164
 165 7) create your database.
 166
 167         mysqladmin -u root create bioseqdb
 168
 169 8) load the schema into your database.
 170
 171         mysql -u root bioseqdb < biosqldb-mysql.sql
 172
 173 9) load the taxonomy database if needed (I think it's
 174    recommended). The script is in the biosql-schema/scripts folder.
 175
 176 Anything I'm missing?  I think I've listed almost everything.  I do
 177 think Cygwin is a good alternative (the installation is exactly like
 178 the instructions).
 179
 180 Chris
 181 ==========================================