annotate OPPL/README @ 4:4f60202c58d9

Added option to push inferred subsumption axioms into output ontology
author Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
date Wed, 14 Sep 2011 19:52:06 +0200
parents 5255f1333cc4
children 68935f90c2db
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 ===========
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
5 OPPL-GALAXY
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
6 ===========
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
7
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
8
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
9
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
10 INSTALLATION
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
11 ============
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
12
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
13 1.- Stop galaxy.
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
14
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
15 2.- Copy oppl_galaxy_tool.jar and oppl_galaxy_tool_lib/ to
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
16 /galaxy-dist/tool-data/shared/jars/.
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
17
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
18 3.- Create directory /galaxy-dist/tools/OPPL/.
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
19
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
20 4.- Copy oppl.xml to /galaxy-dist/tools/OPPL/.
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
21
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
22 5.- Add the following lines to /galaxy-dist/tool_conf.xml:
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
23
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
24 <section name="Ontology Pre Processor Language" id="oppl">
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
25 <tool file="OPPL/oppl.xml"/>
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
26 </section>
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 6.- Start galaxy.
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 Note that if you want you can use any java parameter by editing oppl.xml
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
31 , eg: <command>java -Xmx7000M -Xms250M -DentityExpansionLimit=1000000000
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
32 -jar ${__tool_data_path__}/shared/jars/oppl_galaxy_tool.jar $input $OPPL
3
5255f1333cc4 Version 1.0.1
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents: 0
diff changeset
33 $format > $output </command>
0
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
34
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
35
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
36
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
37 USAGE
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 An ontology and an OPPL file are needed (test.owl and test.oppl can be
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
41 used as samples). Load both:
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
42
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
43 Get Data
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
44 >> Upload File from your computer
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
45
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
46 Then execute the OPPL file against the OWL file:
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
47
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
48 Ontology Pre Processor Language
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
49 >> Execute an OPPL file against an OWL file
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
50
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
51
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
52 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
53 =================
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
54
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
55 OWL import closure.
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
56
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
57 Choose which inferred axioms to add to the output ontology (Right now
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
58 only subsumption is available).
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
59
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
60 Choose reasoner (Right now only Pellet is available).
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
61
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
62
0
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
63
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
64 TESTS
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
65 =====
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
66
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
67 To run the functional test, first complete installation and then:
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
68
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
69 1.- Copy test.owl and test.oppl to /galaxy-dist/test-data/
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
70
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
71 2.- Add the following lines to /galaxy-dist/tool_conf.xml.sample
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
72
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
73 <section name="Ontology Pre Processor Language" id="oppl">
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
74 <tool file="OPPL/oppl.xml"/>
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
75 </section>
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
76
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
77 3.- Execute /galaxy-dist/run_functional_tests.sh -id oppl
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
78
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
79
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
80
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
81 CONTACT
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
82 =======
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 Please send any request or comment to mikel.egana.aranguren@gmail.com.
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
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
88 ACKNOWLEDGEMENTS
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 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
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
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
95 COPYRIGHT AND LICENSE
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 (c) 2011 Mikel EgaƱa Aranguren.
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 OPPL-Galaxy is free software: you can redistribute it and/or modify
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
101 it under the terms of the GNU General Public License as published by
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
102 the Free Software Foundation, either version 3 of the License, or
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
103 (at your option) any later version.
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
104
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
105 This program is distributed in the hope that it will be useful,
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
106 but WITHOUT ANY WARRANTY; without even the implied warranty of
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
107 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
108 GNU General Public License for more details.
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
109
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
110 You should have received a copy of the GNU General Public License
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
111 along with this program. If not, see <http://www.gnu.org/licenses/>.
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
112
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
113 OPPL, OWL API and Pellet have their own licenses.
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
114
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
115 Galaxy is distributed as open source under the conditions of the
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
116 Academic Free License (http://www.opensource.org/licenses/academic.php).
46b9d13a44fc First commit (1.0.0)
mikel-egana-aranguren
parents:
diff changeset
117
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