YOWL: Yet another OWL documentor

YOWL is a command line utility that can read a number of RDFS/OWL files, called the repository, and generate a documentation website from it, with visualisations like Class Diagrams (as SVG), Individuals Diagrams and Import Diagrams.

It also detects annotations from the following public ontologies:

This is a fork of the original DOWL project at https://github.com/ldodds/dowl.

INSTALLATION

Install WGET, GraphViz, libraptor1:

OS X

You can do this using macports or homebrew.

Macports:

$ sudo port install wget graphviz

Homebrew:

$ sudo brew install wget graphviz

Unfortunately, there is no clean way (as far as we know) to install libraptor1 via a package manager on OS X. Therefore we wrote a small shell script, install-raptor.sh to do it for you. 

$ sudo curl -k https://raw.github.com/jgeluk/yowl/master/install-raptor.sh | bash

Ubuntu

$ sudo apt-get install wget graphviz libraptor1 rubygems

Install via RubyGems

$ gem install yowl

Bleeding Edge/Development Builds

$ git clone https://github.com/jgeluk/yowl.git
$ cd yowl/
$ gem build yowl.gemspec
$ gem install yowl

Usage

Execute yowl -h to see usage options:

$ yowl
yowl [VERSION_WILL_APPEAR_HERE]

Usage: YOWL [<options>]

Specific options:
    -i, --ontology FILES             Read input FILES
    -o, --output DIR                 Write HTML output to DIR
    -t, --template DIR               Use ERB templates in DIR
        --no-vann                    Skip looking for vann:preferedNamespacePrefix

Common options:
    -?, -h, --help                   Show this message
    -V, --version                    Show version
    -v, --verbose                    Show verbose logging
    -q, --quiet                      Suppress most logging

For example, to generate a site for the PROV ontology, download the prov owl file and run YOWL as follows:

$ yowl -i /path/to/prov/*.owl -o /var/www/prov