Mercurial > repos > devteam > blast_datatypes
annotate README.rst @ 6:8615fd8abc04 draft
Uploaded v0.0.16, moving to MIT license and development on GitHub.
No functional changes.
author | peterjc |
---|---|
date | Mon, 29 Jul 2013 12:55:49 -0400 |
parents | |
children | a44a7a5456e1 |
rev | line source |
---|---|
6
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
1 Galaxy datatypes for NCBI BLAST+ suite |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
2 ====================================== |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
3 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
4 These Galaxy datatypes are copyright 2010-2013 by Peter Cock, The James Hutton |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
5 Institute (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
6 Contributions/revisions copyright 2012 Edward Kirton. All rights reserved. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
7 Contributions/revisions copyright 2013 Nicola Soranzo. All rights reserved. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
8 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
9 See the licence text below. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
10 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
11 Note that these files (and the associated BLAST+ wrappers) were originally |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
12 distributed as part of the main Galaxy repository, but as of August 2012 moved |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
13 to the Galaxy Tool Shed as 'blast_datatypes' (and 'ncbi_blast_plus' for the |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
14 wrappers). My thanks to Dannon Baker from the Galaxy development team for his |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
15 assistance with this. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
16 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
17 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
18 History |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
19 ======= |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
20 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
21 These versions numbers initially matched those for 'ncbi_blast_plus', but are |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
22 not used explicitly in the datatypes themselves. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
23 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
24 ======= ====================================================================== |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
25 Version Changes |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
26 ------- ---------------------------------------------------------------------- |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
27 v0.0.11 - Final revision as part of the Galaxy main repository, and the |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
28 first release via the Tool Shed |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
29 v0.0.13 - Uses blast.py instead of xml.py to define the datatypes |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
30 v0.0.14 - Includes datatypes for protein and nucleotide BLAST databases |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
31 (based on work by Edward Kirton) |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
32 v0.0.15 - Fixes a MetadataElement bug and includes more of the optional |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
33 BLAST database files (contribution from Nicola Soranzo) |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
34 v0.0.16 - Adopt standard MIT License. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
35 - Development moved to GitHub, https://github.com/peterjc/galaxy_blast |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
36 ======= ====================================================================== |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
37 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
38 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
39 Installation |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
40 ============ |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
41 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
42 Doing this automatically via the Galaxy Tool Shed is probably simplest. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
43 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
44 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
45 Manual Installation |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
46 =================== |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
47 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
48 Normally you would install this via the Galaxy ToolShed, which would move |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
49 the provided blast.py file into a suitable location and process the |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
50 datatypes_conf.xml entry to be combined with your local configuration. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
51 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
52 However, if you really want to this should work for a manual install. Add |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
53 the following lines to the datatypes_conf.xml file in the Galaxy main folder:: |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
54 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
55 <datatype extension="blastxml" type="galaxy.datatypes.blast:BlastXml" mimetype="application/xml" display_in_upload="true"/> |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
56 <datatype extension="blastdbn" type="galaxy.datatypes.blast:BlastNucDb" mimetype="text/html" display_in_upload="false"/> |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
57 <datatype extension="blastdbp" type="galaxy.datatypes.blast:BlastProtDb" mimetype="text/html" display_in_upload="false"/> |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
58 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
59 and later in the sniffer section:: |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
60 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
61 <sniffer type="galaxy.datatypes.blast:BlastXml"/> |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
62 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
63 Also create the file lib/galaxy/datatypes/blast.py by moving, copying or linking |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
64 the blast.py file provided in this tar-ball. Finally add 'import blast' near |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
65 the start of file lib/galaxy/datatypes/registry.py (after the other import |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
66 lines). |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
67 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
68 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
69 Bug Reports |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
70 =========== |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
71 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
72 You can file an issue here https://github.com/peterjc/galaxy_blast/issues or ask |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
73 us on the Galaxy development list http://lists.bx.psu.edu/listinfo/galaxy-dev |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
74 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
75 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
76 Developers |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
77 ========== |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
78 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
79 BLAST+ datatypes and wrappers, and other tools were originally developed on the |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
80 following hg branch: http://bitbucket.org/peterjc/galaxy-central/src/tools |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
81 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
82 As of July 2013, development is continuing on a dedicated GitHub repository: |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
83 https://github.com/peterjc/galaxy_blast |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
84 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
85 For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball I use |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
86 the following command from the blast_datatypes folder:: |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
87 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
88 $ tar -czf blast_datatypes.tar.gz README.rst datatypes_conf.xml blast.py |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
89 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
90 Check this worked:: |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
91 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
92 $ tar -tzf blast_datatypes.tar.gz |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
93 README.rst |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
94 datatypes_conf.xml |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
95 blast.py |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
96 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
97 For development, rather than having a local ToolShed running, I currently |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
98 use a symlink from lib/galaxy/datatypes/blast.py to the actual file as |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
99 described above. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
100 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
101 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
102 Licence (MIT) |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
103 ============= |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
104 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
105 Permission is hereby granted, free of charge, to any person obtaining a copy |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
106 of this software and associated documentation files (the "Software"), to deal |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
107 in the Software without restriction, including without limitation the rights |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
108 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
109 copies of the Software, and to permit persons to whom the Software is |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
110 furnished to do so, subject to the following conditions: |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
111 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
112 The above copyright notice and this permission notice shall be included in |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
113 all copies or substantial portions of the Software. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
114 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
115 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
116 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
117 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
118 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
119 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
120 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
121 THE SOFTWARE. |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
122 |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
123 NOTE: This is the licence for the Galaxy BLAST datatypes **only**. BLAST+ |
8615fd8abc04
Uploaded v0.0.16, moving to MIT license and development on GitHub.
peterjc
parents:
diff
changeset
|
124 and associated data files are available and licenced separately. |