INSTALL

   1
   2 bioperl-db INSTALLATION
   3
   4 INSTALL BIOPERL FIRST
   5
   6 You need at least the corresponding version of Bioperl. Since this
   7 is bioperl-db 1.5.2, you will need bioperl 1.5.2 or later.
   8 Installation instructions are here:
   9
  10 http://www.bioperl.org/wiki/Installing_Bioperl_for_Unix
  11
  12
  13 THEN 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.biosql.org.
  18 BioSQL requires a relational database, either Mysql, Oracle, or
  19 PostgreSQL.
  20
  21
  22 INSTALL BIOPERL-DB USING CPAN
  23
  24 Enter the CPAN shell:
  25
  26  perl -e shell -MCPAN
  27
  28 Now install:
  29
  30  cpan>install CJFIELDS/BioPerl-DB-1.006900.tar.gz
  31
  32
  33 MANUALLY INSTALL BIOPERL-DB
  34
  35 Use this URL to download the archive:
  36
  37   https://github.com/bioperl/bioperl-db/archive/master.zip
  38
  39 Then:
  40
  41   >unzip master.zip
  42   >cd bioperl-db-master
  43
  44 Issue the following command from within bioperl-db/:
  45
  46   >perl Build.PL
  47
  48 You can run regression tests and install bioperl-db using the
  49 following commands:
  50
  51   >./Build test
  52   >./Build install
  53
  54 NOTE: bioperl-db tests require that the BioSQL database you configure
  55 does NOT have the NCBI taxonomy loaded. Also, the './Build install' step
  56 may require that you have root privileges.
  57
  58
  59 INSTALLING bioperl-db ON WINDOWS
  60
  61 The following page on the BioPerl website has up-to-date
  62 instructions on how to install bioperl-db on Windows:
  63
  64 http://www.bioperl.org/wiki/Installing_Bioperl_on_Windows
  65
  66 (the instructions are aimed at bioperl-core, but apply
  67 equally to bioperl-db)
  68
  69
  70 LOAD THE NCBI TAXONOMY
  71
  72 You should pre-load the NCBI taxonomy database using the
  73 scripts/load_ncbi_taxonomy.pl script in the BioSQL package.
  74 Otherwise you will see errors from mis-parsed organisms when you
  75 attempt to load sequences.
  76
  77
  78 LOAD SEQUENCE DATA
  79
  80 Most people will want to load sequence data into their BioSQL
  81 databases. Use scripts/biosql/load_seqdatabase.pl in the bioperl-db
  82 package to load sequences from sequence files. Do:
  83
  84   >perldoc scripts/biosql/load_seqdatabase.pl
  85
  86 or
  87
  88   >scripts/biosql/load_seqdatabase.pl --help
  89
  90 for more information.
  91
  92 This script has many options to flexibly deal with various update
  93 scenarios. Do read the POD before running an update.
  94
  95
  96 LOAD ONTOLOGIES
  97
  98 Use scripts/biosql/load_ontology.pl in the bioperl-db
  99 package to load ontologies from flat files. Do:
 100
 101   >perldoc scripts/biosql/load_ontology.pl
 102
 103 or
 104
 105   >scripts/biosql/load_ontology.pl --help
 106
 107 for more information.
 108
 109 This script has many options to flexibly deal with various update
 110 scenarios. Do read the POD before running an update. Also, some
 111 ontologies maintain obsoleted terms, for instance the Gene
 112 Ontology. Read the POD for possible options to deal with obsoleted
 113 terms; this is relevant even when you load the ontology the first
 114 time, as you may choose to keep obsoleted terms out of the database
 115 from the start.
 116
 117
 118 FEEDBACK
 119
 120 Write down any problems or praise and send them to
 121 bioperl-l@bioperl.org  ;-)
 122