README.txt

   1 Pygr README
   2 ===========
   3
   4 Introduction
   5 ------------
   6
   7 Pygr is an open source software project used to develop graph database
   8 interfaces for the popular Python language, with a strong emphasis
   9 on bioinformatics applications ranging from genome-wide analysis of
  10 alternative splicing patterns, to comparative genomics queries of
  11 multi-genome alignment data.
  12
  13 Latest Release
  14 --------------
  15
  16 http://www.sourceforge.net/projects/pygr/
  17
  18 Documentation
  19 -------------
  20
  21 doc/pygr/index.html is a good place to start.
  22
  23 You can also check out:
  24
  25 http://bioinfo.mbi.ucla.edu/pygr/docs/
  26
  27 Core Prerequisites
  28 -----------------
  29
  30 1) Python >= 2.1
  31
  32 Apps Prerequiites
  33 -----------------
  34
  35 MySQL-python >= 1.2.0
  36 MySQL >= 3.23.x
  37
  38 Note: While pygr's core functionality is solely dependent on a sane python environment, the aformentioned apps requirements must be installed if one wishes to utilize the apps modules and test code.
  39
  40 Supported Platforms
  41 -------------------
  42
  43 In theory, pygr should work on any platform that adequately supports python.
  44
  45 Here are the OS's we've successfully tested on:
  46
  47 o Linux 2.2.x/2.4.x
  48 o OS X
  49 o OpenBSD
  50 o Windows XP
  51
  52 Installation
  53 ------------
  54
  55 Installing pygr is quite simple.
  56
  57 1) tar -xzvf pygr-0.3.tar.gz
  58 2) cd pygr
  59 3) python setup.py install
  60
  61 Once the test framework has completed successfully, the setup script
  62 will install pygr into python's respective site-packages directory.
  63 If you don't want to install pygr into your system-wide site-packages,
  64 replace the "python setup.py install" command with
  65 "python setup.py build".  This will build pygr but not install it
  66 in site-packages.
  67
  68 Using Pygr
  69 ----------
  70 Pygr contains several modules imported as follows:
  71 from pygr import seqdb # IMPORT SEQUENCE DATABASE MODULE
  72
  73 If you did not install pygr in your system-wide site-packages, you
  74 must set your PYTHONPATH to the location of your pygr build.
  75 For example, if your top-level pygr source directory is PYGRDIR then
  76 you'd type something like:
  77 setenv PYTHONPATH PYGRDIR/build/lib.linux-i686-2.3
  78 where the last directory name depends on your specific architecture.
  79
  80 Pygr has a myriad of applications, however, providing a comprehensive
  81 description of its utility is out of the scope of this document (see
  82 Documentation).
  83
  84 If you wish to test your install using the provided test scripts,
  85 or simply want to give pygr an initial whirl, follow these steps:
  86
  87 1) Flesh out ~/.my.cnf, like so:
  88
  89 ------- cut here -------
  90 [client]
  91 socket = /var/lib/mysql/mysql.sock
  92 user = zach
  93 password = seaurchin007!
  94 ------ cut here -------
  95
  96 2) cd pygr/tests/
  97 3) mysql < HUMAN_SPLICE_03
  98 4) python test.py
  99
 100 License
 101 -------
 102
 103 GPL
 104
 105 Author
 106 ------
 107 Chris Lee <clee@ucla.edu>
 108