Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/constraintautomaton/tree-document-topology-visualizer
A software to draw the topology of a TREE view
https://github.com/constraintautomaton/tree-document-topology-visualizer
graph rdf semantic-web tree-specification visualization
Last synced: about 1 month ago
JSON representation
A software to draw the topology of a TREE view
- Host: GitHub
- URL: https://github.com/constraintautomaton/tree-document-topology-visualizer
- Owner: constraintAutomaton
- License: gpl-3.0
- Created: 2023-03-22T10:14:20.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-06T13:57:43.000Z (over 1 year ago)
- Last Synced: 2024-10-28T13:03:41.132Z (3 months ago)
- Topics: graph, rdf, semantic-web, tree-specification, visualization
- Language: Go
- Homepage:
- Size: 235 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# Tree-document-topology-visualizer
Software to draw the topology of a [TREE view](https://treecg.github.io/specification/).
## How it work
The processing can be divided into 4 steps;
- Query the TREE view to get the [tree:relation](https://treecg.github.io/specification/#Relation)
- Build a graph from the `tree:relation`
- Build a [graphviz graph](https://graphviz.org/)
- Generate a graph file (supported file types: [`dot`, `svg`, `png`, `jpg`](https://github.com/goccy/go-graphviz))
We use the [Link Traversal Query Processessing modules of the SPARQL query engine Comunica](https://github.com/comunica/comunica-feature-link-traversal)
to execute the following SPARQL query to collect information about the [`tree:Relation`](https://treecg.github.io/specification/#Node)
and the current [`tree:Node`s](https://treecg.github.io/specification/#Relation).
```sparql
PREFIX tree:
PREFIX rdf:
SELECT ?node ?nextNode ?operator ?value WHERE {
?node tree:relation ?relation .
?relation tree:node ?nextNode .
?relation rdf:type ?operator.
?relation tree:value ?value .
} LIMIT {limit}
```
We then build a graph from the query response where the vertices are composed of the variables from the SPARQL query `?node` and `?nextNode` and the edges are characterized by the pair (`?node`, `?nextNode`) and are "weighted" with the boolean expression composes with the SPARQL variable `?operator` `?value`.
The graph is forwarded to the [`go-graphviz`](https://github.com/goccy/go-graphviz) library which handles the generation of the graph file.
## Dependencies
- [go version 1.20](https://go.dev/dl/)
- [nodejs v16](https://nodejs.org/en)
- [yarn](https://yarnpkg.com/getting-started/install/)
- [Make](https://www.gnu.org/software/make/) __Optional for building__
## Build
### First use
To build the software for a first time
`make build-all`
It will build the main source code and the `javascript` code used to instantiate Comunica.
### Main source code
To only build the main source code
`make build`
The binary will be located in `./build/tree-visualizer`
### Debugging
To build the code and then run it with the default parameters
`make build-run`
## Usage
To run with the default parameters
`make run`
The binary is located inside the `./build/tree-visualizer`.
To display the help prompt use `-h`.
The file type is inferred from the extension of the path passed to `-p`.
```
Usage of ./build/tree-visualizer:
-l uint
The maximum number of relations (default 18446744073709551615)
-p string
Resulting path of the graph (default "./generated/graph.svg")
-t string
URL of the TREE document (default "http://localhost:3000/ldes/test")
-u Make the graph unlabeled
```
## Test
To run all the tests
`make test`
## TO DO
- [ ] Make a streaming version of the program where the graph is generated has the relations are discovered.
- [ ] Make a mode to handle simpler `tree:relation` without using optional statements in the SPARQL query has it greatly slows down the execution time.
- [ ] Include an option to track the nodes that are traversed when executing a SPARQL query from an outsider Query engine.
- [ ] Option to output an `html` file, with an interactive graph using JavaScript.
- [ ] Create a web assembly binary.
## Bib reference
```bib
@software{Tam_tree-document-topology-visualizer_2023,
author = {Tam, Bryan-Elliott},
doi = {10.5281/zenodo.1234},
month = {4},
title = {{tree-document-topology-visualizer}},
url = {https://github.com/constraintAutomaton/tree-document-topology-visualizer},
version = {1.0.0},
year = {2023}
}
```