grapholscape

Grapholscape

Advanced web viewer for ontologies written in GRAPHOL.

Demo • Features • What is Graphol? • Documentation • Quick Start • Credits

npm install grapholscape

Features

Grapholscape provides advanced and interactive tools to visually inspect all components of the ontology: you can search for predicates, filter elements on the diagram and get information about each element on the screen.

• new Path rendering mode: explore your custom path in the ontology graph, start from a single class and explore incrementally step by step.
• Simplify your ontology:
  • Graphol-lite: summarized view avoiding too complex expressions
  • Floaty Mode: simplify further obtaining an extremely easy representation of the ontology
• Search for entities and their instances through all diagrams contained in the ontology
• Get detailed information about selected element
• Get the OWL2 translation for selected element
• Filter elements that are not necessary for your analysis
• Multi-diagrammatic inspection that allows you to navigate through all diagrams that builds up the ontology

What is Graphol?

GRAPHOL is a visual language for developing ontologies and offers a completely graphical representation of ontologies to users, in order to be easy understood by people who are not skilled in logic. Read more
For building ontologies in Graphol please check our visual editor: Eddy.

Demo

You can try it here or build it locally, then select an example or drop your custom .graphol file in the box on the right side.

Quick Start

For a more detailed explanation please check the documentation and the getting started guide.

Install it via npm:

npm install grapholscape

Basic initialisation with UI widgets.

import { fullGrapholscape } from 'grapholscape'

const grapholscape = await Grapholscape.fullGrapholscape(file, container)
grapholscape.showDiagram(0)

Note : file can be an object of the Web API interface File or a String representing the .graphol file to be displayed.

Once the initialization phase is done, the promise will return a Grapholscape object that can be used to perform actions on the tool. In the example we saw the method showDiagram(0). For the complete api please check Grapholscape Class API.

Information about entities, namesapaces and diagrams are stored in Grapholscape.ontology. Read More in Ontology.

It is possible to pass also a config object to define custom default settings. Read more: configuration.

Build it locally

Install Node and npm.

Clone the repository with

git clone https://github.com/obdasystems/grapholscape.git

Install dependencies:

npm run install

Build in dev/debug mode:

npm run start

Build Instructions

Install npm and Node.js and run npm install before using npm run.

Run npm run <target> in the console. The main targets are:

• start : builds for development (no transpiled), watch for changes and serve demo on http://localhost:8000
• build : builds for production (minified and transpiled with babel)
• doc: generate documentation at docs/generated and copy static demo inside it
• deploy : publish whole generated documentation in docs/generated folder to gh-pages branch from which the github page of the project is served
• test: run all test suites
• clean: clean dist and temp folder

Release Instructions

1. Use npm version [ver] Please review built files and try out demo
2. Push the release: git push && git push --tags
3. Publish to npm: npm publish
4. Create a release on Github from the latest tag
5. Run PUBLISH_DOC github action to deploy the updated documentation

Release a snapshot test version

1. Use npm run snapshot
2. Publish using snapshot tag: npm publish --tag snapshot

To install latest snapshot version use npm i grapholscape@snapshot

Credits

Based on cytoscape.js.