Added documentation of excel2onto. (#456)

emmo-repo · Sep 8, 2022 · 3f4297d · 3f4297d
1 parent 499a56b
commit 3f4297d
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -38,6 +38,8 @@ On top of that EMMOntoPy provides:
     Documents an ontology.
   - [`ontoconvert`](docs/tools-instructions.md#ontoconvert):
     Converts between ontology formats.
+  - [`excel2onto`](docs/tools-instructions.md#excel2onto):
+    Generate an EMMO-based ontology from an excel file.
 
 Some examples of what you can do with EMMOntoPy includes:
 

diff --git a/docs/index.md b/docs/index.md
@@ -38,6 +38,8 @@ On top of that EMMOntoPy provides:
     Documents an ontology.
   - [`ontoconvert`](tools-instructions.md#ontoconvert):
     Converts between ontology formats.
+  - [`excel2onto`](tools-instructions.md#excel2onto):
+    Generate an EMMO-based ontology from an excel file.
 
 Some examples of what you can do with EMMOntoPy includes:
 

diff --git a/docs/tools-instructions.md b/docs/tools-instructions.md
@@ -9,6 +9,7 @@
 - [ontograph](#ontograph)
 - [ontodoc](#ontodoc)
 - [ontoconvert](#ontoconvert)
+- [excel2onto](#excel2onto)
 
 ---
 
@@ -361,3 +362,46 @@ ontoconvert --recursive emmo.ttl owl/emmo.owl
 ### Bugs
 Since parsing the results from the reasoner is currently broken in Owlready2 (v0.37), a workaround has been added to ontoconvert.
 This workaround only only supports FaCT++.  Hence, HermiT and Pellet are currently not available.
+
+
+## `excel2onto`
+
+Tool for converting EMMO-based ontologies from Excel to OWL, making it easy for non-ontologists to make EMMO-based domain ontologies.
+
+The Excel file must be in the format provided by ontology_template.xlsx.
+
+### Usage
+
+```console
+excel2onto [options] excelpath
+```
+
+### Dependencies
+
+- `pandas` (Python package)
+
+### Options
+
+```console
+positional arguments:
+  excelpath             path to excel book
+
+options:
+  -h, --help            show this help message and exit
+  --output OUTPUT, -o OUTPUT
+                        Name of output ontology, ´ontology.ttl´ is default
+  --force, -f           Whether to force generation of ontology on non-fatal
+                        error.
+```
+
+### Examples
+
+Create a `new_ontology.ttl` turtle file from the Excel file `new_ontology.xlsx`:
+```console
+excel2onto -o new_ontology.ttl new_ontology.xlsx
+```
+
+
+### Bugs
+
+`equivalentTo` is currently not supported.