Source code

Download source archive ↓

upstream-extended/community/tools/biopython/converters/readme.rst

1Conversion Suite powered by biopython
2=====================================
3
4This suite is copyright 2012 by Björn Grüning, Brad Chapman and Peter Cock
5
6It's aim is to provide a place to host different small and useful scripts, that do not justify an own repository.
7The first wrappers are all powered by biopython [1]. 
8So if you like it please cite:
9
10P.J.A. Cock, T. Antao, J.T. Chang, B.A. Chapman, C.J. Cox, A. Dalke, I. Friedberg, T. Hamelryck, F. Kauff, B. Wilczynski and M.J.L. de Hoon (2009)
11Biopython: freely available Python tools for computational molecular biology and bioinformatics. Bioinformatics, doi:10.1093/bioinformatics/btp163
12
13[1] http://biopython.org/
14
15
16Installation
17============
18
19Biopython is included in every major unix distribution and you can install with your favorite package manager.
20If you need to install it manually please refer to:
21http://biopython.org/DIST/docs/install/Installation.html
22
23
24The GFF manipulation tools also need an additional library developed by Brad Chapman. You can find it under:
25https://github.com/chapmanb/bcbb/tree/master/gff/BCBio
26
27Make sure to put the BCBio folder somewhere in your PYTHONPATH.
28For example with:
29export PYTHONPATH=$PYTHONPATH:/home/user/path-to-BCBio/
30
31
32To install the wrapper copy the converters folder in the galaxy tools
33folder and modify the tools_conf.xml file to make the tool available to Galaxy.
34For example:
35
36<section name="Converters" id="additional-converters">
37    <tool file="converters/translate.xml" />
38    <tool file="converters/reverse_comlement.xml" />
39    <tool file="converters/gff_to_sequence.xml" />
40    <tool file="converters/gff_to_gb_or_embl.xml" />
41    <tool file="converters/gb_to_sequence.xml" />
42    <tool file="converters/gb_embl_to_gff.xml" />
43    <tool file="converters/sequence_converter.xml" />
44</section>
45
46It is probably a good idea to include the tools in one of the existing sections like 'Convert Formats'.
47
48Contact
49=======
50
51If you encounter any problems, have patches or suggestions for improvments you can send an email to:
52
53bjoern-at-gruenings-dot-eu
54
55
56History
57=======
58
59v0.1 - Initial public release
60
61
62Wrapper Licence (MIT/BSD style)
63===============================
64
65Permission to use, copy, modify, and distribute this software and its
66documentation with or without modifications and for any purpose and
67without fee is hereby granted, provided that any copyright notices
68appear in all copies and that both those copyright notices and this
69permission notice appear in supporting documentation, and that the
70names of the contributors or copyright holders not be used in
71advertising or publicity pertaining to distribution of the software
72without specific prior permission.
73
74THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL
75WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
76WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
77CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT
78OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
79OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
80OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
81OR PERFORMANCE OF THIS SOFTWARE.
82