binaries/src/globplot/biopython-1.50/README

   1 #### THIS IS A REDUCED DESTRIBUTION OF BIOPYTHON ####
   2
   3 **Biopython README file**
   4
   5         "The Biopython Project":http://www.biopython.org/ is an
   6 international association of developers of freely available Python
   7 tools for computational molecular biology.
   8
   9 biopython.org provides an online resource for modules, scripts, and
  10 web links for developers of Python-based software for life science
  11 research.  Thanks to bioperl, we can also provide web, FTP and CVS
  12 space for individuals and organizations wishing to distribute or
  13 otherwise make available standalone scripts & code.
  14
  15 This Biopython package is made available under generous terms.  Please
  16 see the LICENSE file for further details.
  17
  18
  19 **For the impatient**
  20
  21 To build and install Biopython, download and unzip the source code,
  22 go to this directory at the command line, and type:
  23
  24 python setup.py build
  25 python setup.py test
  26 python setup.py install
  27
  28 **System Requirements**
  29
  30 o "Python 2.3, 2.4, 2.5 or 2.6":http://www.python.org/
  31   Note that Biopython 1.50 is expected to the our final release to support
  32   Python 2.3.  Given that Python 2.6 is still very new, it would be prudent
  33   to opt for Python 2.5 or 2.4 at this time.
  34
  35 o "NumPy":http://numpy.scipy.org/ (optional, but strongly recommended)
  36   This package is only used in the computationally-oriented modules.
  37   It is required for Bio.Cluster, Bio.PDB and a few other modules.  If you
  38   think you might need these modules, then please install NumPy first BEFORE
  39   installing Biopython. The older Numeric library is no longer supported in
  40   Biopython.
  41
  42 o "ReportLab":http://www.reportlab.org/downloads.html (optional)
  43   This package is only used in Bio.Graphics, so if you do not need this
  44   functionality, you will not need to install this package.  You can install
  45   it later if needed.
  46
  47 o "psycopg":http://initd.org/software/psycopg/ (optional) or
  48   "pgdb":http://www.druid.net/pygresql/ (optional)
  49   These packages are used by BioSQL to access a PostgreSQL database.
  50
  51 o "MySQLdb":http://sourceforge.net/projects/mysql-python (optional)
  52   This package is used by BioSQL or Bio.GFF to access a MySQL database.
  53
  54 o "mxTextTools":http://www.egenix.com/files/python/mxTextTools.html (unlikely)
  55   You probably won't need mxTextTools.  This was used in some of Biopython's
  56   older parsers, and Martel/Mindy, but these have all been deprecated now.
  57
  58 In addition there are a number of useful third party tools you may wish to
  59 install such as standalone NCBI BLAST or ClustalW.
  60
  61
  62 **Installation**
  63
  64 *** Make sure that Python is installed correctly ***
  65
  66 Installation should be as simple as going to the biopython source code
  67 directory, and typing:
  68
  69         'python setup.py build'
  70         'python setup.py test'
  71         'sudo python setup.py install'
  72
  73 If you need to do additional configuration, e.g. changing the base
  74 directory, please type 'python setup.py', or see the documentation for
  75 Distutils.
  76
  77
  78 **Testing**
  79
  80 Biopython includes a suite of regression tests to check if everything is
  81 running correctly.  To do the tests, go to the biopython source code directory
  82 and type:
  83
  84         'python setup.py test'
  85
  86 Do not panic if you see messages warning of skipped tests:
  87     test_DocSQL ... skipping. Install MySQLdb if you want to use Bio.DocSQL.
  88
  89 This most likely means that a package is not installed.  You can
  90 ignore this if it occurs in the tests for a module that you were not
  91 planning on using.  If you did want to use that module, please install
  92 the required dependency and re-run the tests.
  93
  94
  95 **Bugs**
  96
  97 While we try to ship a robust package, bugs inevitably pop up.  If you
  98 are having problems that might be caused by a bug in Biopython, it is
  99 possible that it has already been identified.  Search the
 100 "bug database":http://bugzilla.open-bio.org/ and mailing lists
 101 to see if it has already been reported (and hopefully fixed).
 102
 103 If you suspect the problem lies within a parser, it is likely that the
 104 data format has changed and broken the parsing code.  (The BLAST and
 105 GenBank formats seem to be particularly fragile.)  Thus, the parsing
 106 code in Biopython is sometimes updated faster than we can build Biopython
 107 releases.  You can get the most recent parser by pulling the relevant
 108 files (e.g. the ones in Bio.SeqIO or Bio.Blast) out of
 109 "anonymous cvs":http://cvs.biopython.org/ .
 110 However, be careful when doing this, because the code in CVS is not as
 111 well-tested as released code, and may contain new dependencies.
 112
 113 Finally, you can send a bug report to the bug database or
 114 biopython@biopython.org.  In the bug report, please let us know 1)
 115 which operating system and hardware you are using, 2) Python version,
 116 3) Biopython version (or CVS version/date), 4) traceback that occurs,
 117 5) offending code, and 6) data file that causes the problem.
 118
 119
 120
 121 **Contributing, Bug Reports**
 122
 123 Biopython is run by volunteers from all over the world, with many
 124 types of backgrounds. We are always looking for people interested in
 125 helping with code development, web-site management, documentation
 126 writing, technical administration, and whatever else comes up.
 127
 128 If you wish to contribute, please visit the
 129 "web site":http://www.biopython.org
 130 and join our "mailing list":http://biopython.org/wiki/Mailing_lists
 131
 132
 133
 134 **Distribution Structure**
 135
 136 README       -- This file.
 137
 138 NEWS         -- Release notes and news
 139
 140 LICENSE      -- What you can do with the code.
 141
 142 CONTRIB      -- An (incomplete) list of people who helped Biopython in
 143                 one way or another.
 144
 145 DEPRECATED   -- Contains information about modules in Biopython that are
 146                 removed or no longer recommended for use, and how to update
 147                 code that uses those modules.
 148
 149 MANIFEST.in  -- Tells distutils what files to distribute
 150
 151 setup.py     -- Installation file.
 152
 153 Bio/         -- The main code base code.
 154
 155 Martel/      -- Code for the Martel parsing system, once used in many
 156                 Biopython parsers but now deprecated.
 157
 158 BioSQL/      -- Code for using Biopython with BioSQL databases.
 159
 160 Doc/         -- Documentation.
 161
 162 Scripts/     -- Miscellaneous, possibly useful, standalone scripts
 163
 164 Tests/       -- Regression testing code