annotate README.txt @ 0:c55bdc2fb9fa

Uploaded
author davidmurphy
date Thu, 27 Oct 2011 12:09:09 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
1
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
2 CodonLogo (http://recode.ucc.ie/CodonLogo) is a tool for creating sequence
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
3 logos from biological sequence alignments. It can be run on the command line,
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
4 as a standalone webserver or as a CGI webapp.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
5
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
6
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
7 For help on the command line interface run
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
8 ./codonlogo --help
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
9
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
10 To build a simple logo run
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
11 ./codonlogo < cap.fa > logo0.eps
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
12
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
13 To run as a standalone webserver at localhost:8080
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
14 ./codonlogo --server
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
15
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
16
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
17 -- Distribution and Modification --
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
18 This package is distributed under the new BSD Open Source License.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
19 Please see the LICENSE.txt file for details on copyright and licensing.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
20 The CodonLogo source code can be downloaded from
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
21 http://recode.ucc.ie/CodonLogo
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
22
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
23 CodonLogo requires Python 2.6 or 2.7, the corebio python toolkit for
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
24 computational biology (http://code.google.com/p/corebio), and the python
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
25 array package 'numpy' (http://www.scipy.org/Download)