annotate README.txt @ 4:4d47ab2b7bcc

Uploaded
author davidmurphy
date Fri, 13 Jan 2012 07:18:19 -0500
parents
children 5149eb3a89c2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
1
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
2 CodonLogo (http://recode.ucc.ie/CodonLogo) is a tool for creating sequence
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
3 logos from biological sequence alignments. It can be run on the command line,
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
4 as a standalone webserver or as a CGI webapp.
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
5
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
6
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
7 For help on the command line interface run
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
8 ./codonlogo --help
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
9
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
10 To build a simple logo run
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
11 ./codonlogo < cap.fa > logo.eps
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
12
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
13
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
14 To run as a standalone webserver at localhost:8080
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
15 ./codonlogo --server
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
16
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
17
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
18 An example file of probabilities is included, examplepriorfile.txt
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
19 It can be used with the following command.
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
20
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
21 ./codonlogo --prior examplepriorfile.txt < cap.fa > logo.eps
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
22
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
23
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
24 There is a known issue with GPL Ghostscript 9.04 which affects some users which may cause ghostscript to segfault.
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
25 This is not believed to be a problem with CodonLogo.
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
26 This is being investigated. if you encounter this problem it's recommended to downgrade to version 9.01 or earlier of ghostscript.
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
27
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
28
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
29
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
30 -- Distribution and Modification --
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
31 This package is distributed under the new BSD Open Source License.
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
32 Please see the LICENSE.txt file for details on copyright and licensing.
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
33 The CodonLogo source code can be downloaded from
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
34 http://recode.ucc.ie/CodonLogo
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
35
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
36 CodonLogo requires Python 2.6 or 2.7, the corebio python toolkit for
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
37 computational biology (http://code.google.com/p/corebio), and the python
4d47ab2b7bcc Uploaded
davidmurphy
parents:
diff changeset
38 array package 'numpy' (http://www.scipy.org/Download)