Mercurial > repos > mikel-egana-aranguren > oppl
annotate OPPL/README @ 10:3f31c0eb7539
Interface improved
| author | Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu> |
|---|---|
| date | Thu, 12 Jan 2012 10:20:00 +0100 |
| parents | 14bfd77f8520 |
| children | 6ca67b155e32 |
| rev | line source |
|---|---|
| 0 | 1 |
| 2 | |
| 3 | |
| 4 =========== | |
| 5 OPPL-GALAXY | |
| 6 =========== | |
| 7 | |
| 8 | |
| 9 | |
| 10 INSTALLATION | |
| 11 ============ | |
| 12 | |
|
10
3f31c0eb7539
Interface improved
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
9
diff
changeset
|
13 1.- Stop Galaxy. |
| 0 | 14 |
|
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
|
15 2.- Copy oppl_galaxy_tool.jar, FaCT++-linux-v1.5.2/ FaCT++-OSX-v1.5.2/ |
|
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
|
16 and oppl_galaxy_tool_lib/ to /galaxy-dist/tool-data/shared/jars/ |
| 0 | 17 |
|
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
|
18 3.- Create directory /galaxy-dist/tools/OPPL/ |
| 0 | 19 |
|
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
|
20 4.- Copy oppl.xml to /galaxy-dist/tools/OPPL/ |
| 0 | 21 |
| 22 5.- Add the following lines to /galaxy-dist/tool_conf.xml: | |
| 23 | |
| 24 <section name="Ontology Pre Processor Language" id="oppl"> | |
| 25 <tool file="OPPL/oppl.xml"/> | |
| 26 </section> | |
| 27 | |
|
10
3f31c0eb7539
Interface improved
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
9
diff
changeset
|
28 6.- Start Galaxy. |
| 0 | 29 |
| 30 | |
| 31 | |
| 32 USAGE | |
| 33 ===== | |
| 34 | |
| 35 An ontology and an OPPL file are needed (test.owl and test.oppl can be | |
| 36 used as samples). Load both: | |
| 37 | |
| 38 Get Data | |
| 39 >> Upload File from your computer | |
| 40 | |
| 41 Then execute the OPPL file against the OWL file: | |
| 42 | |
| 43 Ontology Pre Processor Language | |
| 44 >> Execute an OPPL file against an OWL file | |
| 45 | |
|
10
3f31c0eb7539
Interface improved
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
9
diff
changeset
|
46 An ontology produced by another galaxy tool can also be used. |
|
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
|
47 |
|
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
|
48 Test.oppl and test.owl can be used as examples. More OPPL-Galaxy |
|
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
|
49 examples can be obtained at http://miuras.inf.um.es/OPPL-Galaxy/, and |
|
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
|
50 general OPPL script that may be useful to use with OPPL-Galaxy can be |
|
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
|
51 obtained at http://oppl2.sourceforge.net/taggedexamples/. |
|
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
|
52 |
|
10
3f31c0eb7539
Interface improved
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
9
diff
changeset
|
53 A public instance of Galaxy with pre-installed OPPL-Galaxy can be used |
|
3f31c0eb7539
Interface improved
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
9
diff
changeset
|
54 at http://sele.inf.um.es:8080/. |
|
3f31c0eb7539
Interface improved
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
9
diff
changeset
|
55 |
| 0 | 56 |
|
5
68935f90c2db
Added OWL imports closure
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
4
diff
changeset
|
57 |
|
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
|
58 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
|
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 |
|
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 Choose which inferred axioms to add to the output ontology (Right now |
|
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
|
62 only subsumption between named classes is available). |
|
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
|
63 |
|
10
3f31c0eb7539
Interface improved
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
9
diff
changeset
|
64 Rendering definition (URI fragment, label, etc). |
|
3f31c0eb7539
Interface improved
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
9
diff
changeset
|
65 |
|
3f31c0eb7539
Interface improved
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
9
diff
changeset
|
66 XML catalog support for imported URIs. |
|
3f31c0eb7539
Interface improved
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
9
diff
changeset
|
67 |
|
3f31c0eb7539
Interface improved
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
9
diff
changeset
|
68 OWLLink and Racer support. |
|
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 |
|
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 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
|
73 ===================== |
|
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
|
74 |
|
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
|
75 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
|
76 error, which is bad since OPPL (And many other tools) throw info to |
|
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
|
77 sdterr even if working properly. In OPPL Galaxy, stderr is redirected to |
|
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
|
78 /dev/null to avoid the problem, but that means that OPPL Galaxy does not |
|
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 fail gracefully (It simply stops). A wrapper will be implemented. |
|
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 |
|
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 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
|
82 |
|
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
|
83 |
| 0 | 84 |
| 85 TESTS | |
| 86 ===== | |
| 87 | |
| 88 To run the functional test, first complete installation and then: | |
| 89 | |
| 90 1.- Copy test.owl and test.oppl to /galaxy-dist/test-data/ | |
| 91 | |
| 92 2.- Add the following lines to /galaxy-dist/tool_conf.xml.sample | |
| 93 | |
| 94 <section name="Ontology Pre Processor Language" id="oppl"> | |
| 95 <tool file="OPPL/oppl.xml"/> | |
| 96 </section> | |
| 97 | |
| 98 3.- Execute /galaxy-dist/run_functional_tests.sh -id oppl | |
| 99 | |
| 100 | |
| 101 | |
| 102 CONTACT | |
| 103 ======= | |
| 104 | |
| 105 Please send any request or comment to mikel.egana.aranguren@gmail.com. | |
| 106 | |
| 107 | |
| 108 | |
| 109 ACKNOWLEDGEMENTS | |
| 110 ================ | |
| 111 | |
| 112 This work is funded by the Marie Curie Cofund program of the EU, FP7. | |
| 113 | |
| 114 | |
| 115 | |
| 116 COPYRIGHT AND LICENSE | |
| 117 ===================== | |
| 118 | |
| 119 Copyright (c) 2011 Mikel Egaña Aranguren. | |
| 120 | |
| 121 OPPL-Galaxy is free software: you can redistribute it and/or modify | |
| 122 it under the terms of the GNU General Public License as published by | |
| 123 the Free Software Foundation, either version 3 of the License, or | |
| 124 (at your option) any later version. | |
| 125 | |
| 126 This program is distributed in the hope that it will be useful, | |
| 127 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 128 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 129 GNU General Public License for more details. | |
| 130 | |
| 131 You should have received a copy of the GNU General Public License | |
| 132 along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 133 | |
|
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
|
134 OPPL API, OWL API, Pellet, HermiT, and FaCT++ have their own licenses. |
| 0 | 135 |
| 136 | |
| 137 | |
| 138 | |
| 139 | |
| 140 | |
| 141 | |
| 142 |