Skip to content

opencaesar/oml-template

Repository files navigation

OML Template

Build Status Release Documentation

This repository has a template OML project. It is meant to be forked as a starting point by pressing the 'Use this template' button above.

this template is suitable for use with OML Rosetta and OML Luxor (but not OML Vision)

Clone

  git clone https://github.com/opencaesar/oml-template.git
  cd oml-template

Build

Check the consistency of the dataset

./gradlew build

Generate Docs

Generate documentation from dataset

./gradlew generateDocs

Start Fuseki Server

Start the Fuseki triple store

./gradlew startFuseki

Navigate to http://localhost:3030

Verify you see a dataset: template

Stop Fuseki Server

Stop the Fuseki triple store

./gradlew stopFuseki

Load Dataset to Fuseki

Load the dataset to Fuseki server

./gradlew load

Navigate to http://localhost:3030/#/dataset/template/info

Click on count triples in all graphs and observe the triple counts

Run SPARQL Queries

Run the SPARQL queries

./gradlew query

Inspect the results at build/results/template

Run SHACL Rules

Run the SHACL rules

./gradlew validate

Inspect the results at build/logs/template

Publish to Maven Local

Publish the OML dataset as an archive in the local maven repo

./gradlew publishToMavenLocal

Inspect the OML archive

ls ~/.m2/repository/io/opencaesar/oml-template

Customize Template

The name of this project is oml-template. You can change it to your own project name. The easiest way to do this is to look for the word template in this repo and replace it. The files that need to be changes include:

  • .project (name)
  • .catalog.xml (first rewriteURI)
  • README.md (various places)
  • .oml/fuseki.ttl (fuseki:name)
  • .oml/oml.yml (various places)
  • src/oml/* (namespaces of ontologies)
  • src/sparcl/* (namespaces of ontologies)
  • src/shacl/* (namespaces of ontologies)