annotate OPPL/README @ 15:622cde484f4c draft

Add new tool to perform OPPL queries
author Mikel Egana Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
date Thu, 12 Jul 2012 17:12:00 +0200
parents 7e6604a5ee55
children c9e01f86b07c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
1
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
2
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
3
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
4 INSTALLATION
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
5 ============
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
6
10
3f31c0eb7539 Interface improved
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 9
diff changeset
7 1.- Stop Galaxy.
0
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
8
11
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
9 2.- Copy the following files and dirs to
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
10 /galaxy-dist/tool-data/shared/jars/:
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
11
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
12 oppl_galaxy_tool.jar
13
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
13 inference.jar
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
14 query.jar
15
622cde484f4c Add new tool to perform OPPL queries
Mikel Egana Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 13
diff changeset
15 oppl_query.jar
13
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
16 oppl_galaxy_lib/
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
17 inference_lib/
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
18 query_lib/
15
622cde484f4c Add new tool to perform OPPL queries
Mikel Egana Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 13
diff changeset
19 oppl_query_lib/
11
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
20 FaCT++-linux-v1.5.2/
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
21 FaCT++-OSX-v1.5.2/
13
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
22
9
14bfd77f8520 Interface improved (Imports first) and proper handling of import/merge options added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 8
diff changeset
23 3.- Create directory /galaxy-dist/tools/OPPL/
0
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
24
13
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
25 4.- Copy oppl.xml, inference.xml and query.xml to
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
26 /galaxy-dist/tools/OPPL/
0
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
27
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
28 5.- Add the following lines to /galaxy-dist/tool_conf.xml:
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
29
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
30 <section name="Ontology Pre Processor Language" id="oppl">
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
31 <tool file="OPPL/oppl.xml"/>
11
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
32 <tool file="OPPL/inference.xml"/>
13
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
33 <tool file="OPPL/query.xml"/>
15
622cde484f4c Add new tool to perform OPPL queries
Mikel Egana Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 13
diff changeset
34 <tool file="OPPL/oppl_query.xml"/>
0
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
35 </section>
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
36
10
3f31c0eb7539 Interface improved
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 9
diff changeset
37 6.- Start Galaxy.
0
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
38
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
39
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
40
4
4f60202c58d9 Added option to push inferred subsumption axioms into output ontology
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 3
diff changeset
41 FORESEEN FEATURES
4f60202c58d9 Added option to push inferred subsumption axioms into output ontology
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 3
diff changeset
42 =================
4f60202c58d9 Added option to push inferred subsumption axioms into output ontology
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 3
diff changeset
43
15
622cde484f4c Add new tool to perform OPPL queries
Mikel Egana Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 13
diff changeset
44 General (OPPL, Inference, Query, OPPL query):
11
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
45
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
46 - Support for processing ontologies that import other ontologies loaded
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
47 in galaxy.
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
48
13
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
49 - Entities rendering definition (URI fragment, rdfs:label, QName, etc).
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
50
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
51 - OWLLink and Racer support.
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
52
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
53
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
54 OPPL:
8
40adbcb2a7cc Added merge function and FaCT++ support. Improved OBO render
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 6
diff changeset
55
11
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
56 - Standalone OPPL assertions parsing (e.g. ADD phagocyte subClassOf
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
57 cell).
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
58
13
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
59 - Other output formats apart from RDF/XML.
11
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
60
10
3f31c0eb7539 Interface improved
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 9
diff changeset
61
11
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
62 Inference:
10
3f31c0eb7539 Interface improved
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 9
diff changeset
63
13
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
64 - Support for DataPropertyAssertion, DataPropertyHierarchy,
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
65 DifferentIndividuals, ...
8
40adbcb2a7cc Added merge function and FaCT++ support. Improved OBO render
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 6
diff changeset
66
15
622cde484f4c Add new tool to perform OPPL queries
Mikel Egana Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 13
diff changeset
67 OPPL query:
622cde484f4c Add new tool to perform OPPL queries
Mikel Egana Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 13
diff changeset
68
8
40adbcb2a7cc Added merge function and FaCT++ support. Improved OBO render
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 6
diff changeset
69
40adbcb2a7cc Added merge function and FaCT++ support. Improved OBO render
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 6
diff changeset
70
40adbcb2a7cc Added merge function and FaCT++ support. Improved OBO render
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 6
diff changeset
71 KNOWN BUGS AND ISSUES
40adbcb2a7cc Added merge function and FaCT++ support. Improved OBO render
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 6
diff changeset
72 =====================
4
4f60202c58d9 Added option to push inferred subsumption axioms into output ontology
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 3
diff changeset
73
8
40adbcb2a7cc Added merge function and FaCT++ support. Improved OBO render
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 6
diff changeset
74 Currently Galaxy interprets any information thrown to stderr as a tool
40adbcb2a7cc Added merge function and FaCT++ support. Improved OBO render
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 6
diff changeset
75 error, which is bad since OPPL (And many other tools) throw info to
11
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
76 sdterr even if working properly. In OPPL Galaxy, stderr is redirected
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
77 to /dev/null to avoid the problem, but that means that OPPL Galaxy does
6ca67b155e32 Imports simplified, new tool for inference added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 10
diff changeset
78 not fail gracefully (It simply stops). A wrapper will be implemented.
8
40adbcb2a7cc Added merge function and FaCT++ support. Improved OBO render
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 6
diff changeset
79
40adbcb2a7cc Added merge function and FaCT++ support. Improved OBO render
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 6
diff changeset
80 http://wiki.g2.bx.psu.edu/Future/Job%20Failure%20When%20stderr
40adbcb2a7cc Added merge function and FaCT++ support. Improved OBO render
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 6
diff changeset
81
4
4f60202c58d9 Added option to push inferred subsumption axioms into output ontology
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 3
diff changeset
82
0
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
83
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
84 CONTACT
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
85 =======
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
86
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
87 Please send any request or comment to mikel.egana.aranguren@gmail.com.
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
88
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
89
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
90
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
91 ACKNOWLEDGEMENTS
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
92 ================
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
93
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
94 This work is funded by the Marie Curie Cofund program of the EU, FP7.
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
95
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
96
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
97
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
98 COPYRIGHT AND LICENSE
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
99 =====================
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
100
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
101 Copyright (c) 2011 Mikel EgaƱa Aranguren.
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
102
13
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
103 (OPPL|Inference|Query)-Galaxy
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
104 is free software: you can redistribute it and/or modify it under the
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
105 terms of the GNU General Public License as published by the Free
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
106 Software Foundation, either version 3 of the License, or (at your
7e6604a5ee55 New query tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 11
diff changeset
107 option) any later version.
0
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
108
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
109 This program is distributed in the hope that it will be useful,
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
110 but WITHOUT ANY WARRANTY; without even the implied warranty of
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
111 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
112 GNU General Public License for more details.
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
113
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
114 You should have received a copy of the GNU General Public License
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
115 along with this program. If not, see <http://www.gnu.org/licenses/>.
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
116
9
14bfd77f8520 Interface improved (Imports first) and proper handling of import/merge options added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 8
diff changeset
117 OPPL API, OWL API, Pellet, HermiT, and FaCT++ have their own licenses.
0
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
118
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
119
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
120
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
121
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
122
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
123
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
124
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
125