Grapholscape
Web App • 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](https://github.com/obdasystems/eddy/wiki/Introduction#graphol)\
For building ontologies in Graphol please check our visual editor: [Eddy](https://github.com/obdasystems/eddy).
## [WebApp](https://obdasystems.github.io/grapholscape/public/)
You can try it [here](https://obdasystems.github.io/grapholscape/public/) or [build it locally](#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](https://obdasystems.github.io/grapholscape/) and the [getting started guide](https://obdasystems.github.io/grapholscape/stable/pages/getting-started.html).
### Install it via **npm**:
```cmd
npm install grapholscape
```
### Basic initialisation with UI widgets.
```js
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](https://developer.mozilla.org/en-US/docs/Web/API/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](https://obdasystems.github.io/grapholscape/stable/classes/core.Grapholscape.html).**
Information about **entities**, **namesapaces** and **diagrams** are stored in [Grapholscape.ontology](https://obdasystems.github.io/grapholscape/stable/classes/core.Grapholscape.html). Read More in [Ontology](https://obdasystems.github.io/grapholscape/stable/classes/model.Ontology.html).
It is possible to pass also a config object to define custom default settings. Read more: [configuration](https://obdasystems.github.io/grapholscape/stable/pages/configuration.html).
## Build it locally
Install `Node` and `npm`.
Clone the repository with
```cmd
git clone https://github.com/obdasystems/grapholscape.git
```
Install dependencies:
```cmd
npm run install
```
Build in dev/debug mode:
```cmd
npm run start
```
## Build Instructions
Install `npm` and `Node.js` and run `npm install` before using `npm run`.
Run `npm run