annotate README.rst @ 54:675d25a0b9d4

Uploaded
author bgruening
date Mon, 12 Aug 2013 08:16:21 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
54
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
1 Galaxy datatypes for HOMER tools
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
2 ================================
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
3
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
4 These HOMER datatypes are copyright 2013 by Björn Grüning.
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
5
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
6 See the licence text below.
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
7
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
8
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
9 History
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
10 =======
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
11
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
12 ======= ======================================================================
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
13 Version Changes
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
14 ------- ----------------------------------------------------------------------
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
15 v0.0.1 - First release.
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
16 ======= ======================================================================
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
17
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
18
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
19 Installation
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
20 ============
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
21
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
22 Doing this automatically via the Galaxy Tool Shed is probably simplest.
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
23
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
24
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
25 Manual Installation
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
26 ===================
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
27
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
28 Normally you would install this via the Galaxy ToolShed, which would move
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
29 the provided homer.py file into a suitable location and process the
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
30 datatypes_conf.xml entry to be combined with your local configuration.
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
31
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
32 However, if you really want to this should work for a manual install. Add
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
33 the following lines to the datatypes_conf.xml file in the Galaxy main folder::
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
34
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
35 <datatype extension="homer_tagdir" type="galaxy.datatypes.homer:TagDirectory" mimetype="text/html" display_in_upload="false"/>
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
36
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
37 Also create the file lib/galaxy/datatypes/homer.py by moving, copying or linking
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
38 the homer.py file provided in this tar-ball. Finally add 'import homer' near
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
39 the start of file lib/galaxy/datatypes/registry.py (after the other import
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
40 lines).
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
41
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
42
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
43 Bug Reports
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
44 ===========
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
45
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
46 You can file an issue here https://github.com/bgruening/galaxytools/issues or ask
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
47 us on the Galaxy development list http://lists.bx.psu.edu/listinfo/galaxy-dev
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
48
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
49
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
50 Developers
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
51 ==========
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
52
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
53 Development is happening here:
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
54
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
55 https://github.com/bgruening/galaxytools/
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
56
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
57
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
58 Licence (MIT)
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
59 =============
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
60
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
61 Permission is hereby granted, free of charge, to any person obtaining a copy
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
62 of this software and associated documentation files (the "Software"), to deal
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
63 in the Software without restriction, including without limitation the rights
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
64 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
65 copies of the Software, and to permit persons to whom the Software is
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
66 furnished to do so, subject to the following conditions:
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
67
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
68 The above copyright notice and this permission notice shall be included in
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
69 all copies or substantial portions of the Software.
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
70
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
71 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
72 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
73 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
74 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
75 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
76 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
77 THE SOFTWARE.
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
78
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
79 NOTE: This is the licence for the Galaxy HOMER datatypes **only**. HOMER
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
80 and associated data files are available and licenced separately.