  
-------- -------- -------- -------- -------- -------- -------- -------- --------

      BLASTgres -- Biosequence data management in PostgreSQL
      http://www.blastgres.org/
  
      Copyright (C) 2005, 2006  Ruey-Lung Hsiao,  D.S. Parker
      (rlhsiao@cs.ucla.edu, stott@cs.ucla.edu)
  
      UCLA Center for Computational Biology
      635 Charles Young Drive South, Suite 225
      Los Angeles, CA 90095-7332  USA
  
      UCLA Computer Science Dept.
      3532 Boelter Hall
      Los Angeles, CA 90095-1596  USA
  
      This program is free software; you can redistribute it and/or
      modify it under the terms of the GNU General Public License
      as published by the Free Software Foundation; either version 2 of
      the License, or (at your option) any later version.
  
      This program is distributed in the hope that it will be useful,
      but WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
      See the GNU General Public License for more details.
  
      You should have received a copy of the GNU General Public
      License along with this program; if not, write to the
      Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
      Boston, MA  02110-1301  USA

-------- -------- -------- -------- -------- -------- -------- -------- --------


This overview gives a quick summary of BLASTgres' extensions for PostgreSQL.

Installation of BLASTgres
=========================


To install BLASTgres, do the following:

0. either find the source code distribution of PostgreSQL
   used to construct the version you already have running,
   or obtain the source code distribution from

      http://www.postgresql.org/download/

1. execute the following steps as a user like "postgres" who
   has sufficient administrative authority.

2. copy the BLASTgres source directory into the /contrib/ subdirectory

        cp  -Rp   .../BLASTgres/   .../postgresql-X.Y.Z/contrib/

3. ensure that your environment defines the PGLIB and PGDATA variables,
   and the PostgreSQL binaries are in your PATH  (normally the binaries
   are in something like /usr/local/pgsql/bin/).  You can use the
   following command to get the environment variable for PGLIB:

        pg_config --libdir      (for PGLIB)

4. compile and install the BLASTgres extensions to PostgreSQL:

        make
        make install (you might need to have administrator privileges)

   This installs the BLASTgres datatypes, functions, and documentation
   so that PostgreSQL knows where to find them.

5. With PostgreSQL, even if BLASTgres is installed as above,
   BLASTgres will not available by default in every database.
   It will need to be included in each database explicitly.

   To include BLASTgres in any particular database, do

       psql -d mydatabasename < BLASTgres.sql

   where BLASTgres.sql is the file in the /BLASTgres/ directory; after
   this, your queries in the database can use BLASTgres constructs.

   However: if you want all subsequently created databases to
   automatically get access to BLASTgres, just install it in the
   "template1" database.


