Code Monkey home page Code Monkey logo

yowl's Introduction

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/modelfabric/yowl/master/install-raptor.sh | bash

Ubuntu

$ sudo apt-get install wget graphviz libraptor1-dev rubygems

Amazon Linux

$ sudo yum -y install graphviz libraptor1-dev rubygems ruby-devel ffi-devel make gcc

And then install Raptor 1.4.21 (which is required by rdf-raptor) like this:

$ sudo yum -y install http://download.librdf.org/binaries/redhat/fc12/raptor-1.4.21-1.fc12.x86_64.rpm
$ sudo yum -y install http://download.librdf.org/binaries/redhat/fc12/raptor-devel-1.4.21-1.fc12.x86_64.rpm

Install via RubyGems

$ gem install yowl

Bleeding Edge/Development Builds

$ git clone https://github.com/modelfabric/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

yowl's People

Contributors

jgeluk avatar ldodds avatar traviskaufman avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.