Commit 3558b98c authored by MANOLESCU Ioana's avatar MANOLESCU Ioana
Browse files

Update README.md

parent 0b382d7c
# Introduction
ConnectionLens ingests heterogeneous data sources (JSON, XML, HTML, CSV, RDF, relational databases, text files, PDF files) into a single, integrated graph. It stores these graphs, then allows querying them using keywords, and exploring them through a GUI.
### Download
The software consists of two main modules (sub-projects):
- **Core** provides the main project functionalities (data ingestion, graph storage, querying)
- **Gui** is a standalone J2EE web app which allows interactive exploration of the graph.
A clone of this repository includes:
1. The `core` folder which provides:
- the jar file `connection-lens-core-full-1.1-SNAPSHOT.jar`,
- the python `scripts` folder (these implement an entity extraction based on Flair),
- a `properties` file which allow controlling multiple parameters related to the execution.
The project was started in 2018, see the [about us](about.md) page for a list of all authors.
2. The `gui` folder with the file `gui.war` that allows to run the web app.
3. The `data` folder with a few sample datasets (RDF, JSON, XML etc.)
4. The `models` folder which provides linguistic models used by the TreeTagger and StanfordNLP tools we build upon.
# Download & Install
# Install
### Software prerequisites
Required:
......@@ -22,23 +28,6 @@ Optional
- [Graphviz (DOT)](https://www.graphviz.org/)
### Download
To download connectionLens, you need to clone this git repository:
The cloned folder will include:
1. The `core` folder which provides:
- the jar file `connection-lens-core-full-1.1-SNAPSHOT.jar`,
- the python scripts folder (to run Flair),
- a properties file with the default parameters.
2. The `gui` folder which provides the war file `gui.war` to run the web app.
3. The `data` folder with some samples with differents formats: rdf, xml, html...
4. The `models` folder which provides all the models in French and English used within `TreeTagger` and `Stanford` tool.
......@@ -128,4 +117,6 @@ If you found a bug or issue with ConnectionLens please let us know. You can repo
- Do not forget to mention your OS and all important information.
## About
ConnectionLens development starteed in 2018. See the [about us](about.md) page for a list of all authors.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment