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 Otherwise, copy or rename t/DBHarness.conf.example to
  35 t/DBHarness.biosql.conf and edit the file as needed. Then issue the
  36 following commands from within bioperl-db/:
  37
  38   >perl Makefile.PL
  39   >make
  40
  41 You can run regression tests and install bioperl-db using the
  42 following commands:
  43
  44   >make test
  45   >make install
  46
  47 NOTE:  bioperl-db tests require that the BioSQL database in
  48 DBHarness.biosql.conf does NOT have NCBI taxonomy loaded.  Also,
  49 the 'make install' step may require that you have root privileges.
  50
  51
  52 INSTALLING bioperl-db ON WINDOWS
  53
  54 The following page on the BioPerl website has up-to-date
  55 instructions on how to install bioperl-db on Windows:
  56
  57 http://www.bioperl.org/wiki/Installing_Bioperl_on_Windows
  58
  59
  60 LOAD THE NCBI TAXONOMY
  61
  62 You should pre-load the NCBI taxonomy database using the
  63 scripts/load_ncbi_taxonomy.pl script in the BioSQL package.
  64 Otherwise you will see errors from mis-parsed organisms when you
  65 attempt to load sequences.
  66
  67
  68 LOAD SEQUENCE DATA
  69
  70 Most people will want to load sequence data into their BioSQL
  71 databases. Use scripts/biosql/load_seqdatabase.pl in the bioperl-db
  72 package to load sequences from sequence files. Do:
  73
  74   >perldoc scripts/biosql/load_seqdatabase.pl
  75
  76 or
  77
  78   >scripts/biosql/load_seqdatabase.pl --help
  79
  80 for more information.
  81
  82 This script has many options to flexibly deal with various update
  83 scenarios. Do read the POD before running an update.
  84
  85
  86 LOAD ONTOLOGIES
  87
  88 Use scripts/biosql/load_ontology.pl in the bioperl-db
  89 package to load ontologies from flat files. Do:
  90
  91   >perldoc scripts/biosql/load_ontology.pl
  92
  93 or
  94
  95   >scripts/biosql/load_ontology.pl --help
  96
  97 for more information.
  98
  99 This script has many options to flexibly deal with various update
 100 scenarios. Do read the POD before running an update. Also, some
 101 ontologies maintain obsoleted terms, for instance the Gene
 102 Ontology. Read the POD for possible options to deal with obsoleted
 103 terms; this is relevant even when you load the ontology the first
 104 time, as you may choose to keep obsoleted terms out of the database
 105 from the start.
 106
 107
 108 FEEDBACK
 109
 110 Write down any problems or praise and send them to
 111 bioperl-l@bioperl.org  ;-)
 112