Skip to content

eccenca/cmem-plugin-reason

Repository files navigation

cmem-plugin-reason

This eccenca Corporate Memory workflow plugin bundle contains plugins performing reasoning (Reason) and ontology consistency checking (Validate) using ROBOT.

eccenca Corporate Memory workflow pypi version license

ROBOT is published under the BSD 3-Clause "New" or "Revised" License. Copyright © 2015, the Authors

Build

➜ task clean build

Installation

➜ cmemc admin workspace python install dist/*.tar.gz

Alternatively, the build and installation process can be initiated with the single command:

➜ task deploy

Reason

Options

Data graph IRI

The IRI of the input data graph. The graph IRI is selected from a list of graphs of types di:Dataset, void:Dataset and owl:Ontology.

Ontology graph IRI

The IRI of the input ontology graph. The graph IRI is selected from a list of graphs of typeowl:Ontology.

Result graph IRI

The IRI of the output graph for the reasoning result.

⚠️ Existing graphs will be overwritten.

Reasoner

The following reasoner options are supported:

Generated Axioms

By default, the reason operation will only assert inferred subclass axioms. The plugin provides the following parameters to include inferred axiom generators:

Class axiom generators

  • SubClass
  • EquivalentClass
  • DisjointClasses

Data property axiom generators

  • DataPropertyCharacteristic
  • EquivalentDataProperties
  • SubDataProperty

Individual axiom generators

  • ClassAssertion
  • PropertyAssertion

Object property axiom generators

  • EquivalentObjectProperty
  • InverseObjectProperties
  • ObjectPropertyCharacteristic
  • SubObjectProperty
  • ObjectPropertyRange
  • ObjectPropertyDomain

Validate OWL2 profiles

Validate the input ontology against OWL profiles (DL, EL, QL, RL, and Full). The ontology is annotated in the output graph.

Process valid OWL profiles from input

If enabled along with the "Validate OWL2 profiles" parameter, the ontology IRI and list of valid profiles is taken from the config port input, without validating the ontology against the profiles in the plugin. If the "Validate OWL2 profiles" parameter is enabled in the "Validate" plugin, it can be directly connected to the input of the "Reason" plugin.

Maximum RAM Percentage

Maximum heap size for the Java virtual machine in the DI container running the reasoning process.

⚠️ Setting the percentage too high may result in an out of memory error.

Validate

The plugin outputs the explanation as text in Markdown format on the path "markdown", the ontology IRI on the path "ontology_graph_iri", and (if enabled) the valid OWL2 profiles on the path "valid_profiles" as a comma-separated string.

Options

Ontology graph IRI

The IRI of the input ontology graph. The graph IRI is selected from a list of graphs of typeowl:Ontology.

Reasoner

The following reasoner options are supported:

Produce output graph

If enabled, an explanation graph is created.

Output graph IRI

The IRI of the output graph for the reasoning result.

⚠️ Existing graphs will be overwritten.

Write markdown explanation file

If enabled, an explanation markdown file is written to the project.

Output filename

The filename of the Markdown file with the explanation of inconsistencies.

⚠️ Existing files will be overwritten.

Stop at inconsistencies

Raise an error if inconsistencies are found. If enabled, the plugin does not output entities.

Validate OWL2 profiles

Validate the input ontology against OWL profiles (DL, EL, QL, RL, and Full). The valid profiles are added to the output Markdown file and the ontology is annotated in the output graph. The plugin outputs the profiles with path "profile", and the ontology IRI with path "ontology".

Maximum RAM Percentage

Maximum heap size for the Java virtual machine in the DI container running the reasoning process.

⚠️ Setting the percentage too high may result in an out of memory error.