Commit a4ea977e authored by MANOLESCU Ioana's avatar MANOLESCU Ioana
Browse files

Update README.md

parent 3558b98c
### Download
# Download
A clone of this repository includes:
......@@ -16,36 +16,33 @@ A clone of this repository includes:
# Install
### Software prerequisites
## Software prerequisites
Required:
- Java >= 1.8
- Maven >= 3.0.5
- PostgreSQL (tested with v.9.6)
- Python 3
- Tomcat >=8.*
Optional
Optional:
- [Graphviz (DOT)](https://www.graphviz.org/)
## Installation instructions
## Installation Instructions
In order to run ConnectionLens (Jar and War) you need to follow installation instructions for Core and Gui:
ConnectionLens can be run in two modes: *text* (command-line like), using the **jar**; and *graphical* (with the help of a GUI), by deploying the **war** in a Web server (we tested with Tomcat).
The respective installation instructions are:
- [ConnectionLens-Core installation instructions](core_install.md)
- [ConnectionLens-Gui installation instructions](gui_install.md)
# Example
This example explain how you can ingest small dataset (5 data sources) with different formats, querying the graph and visualize the results.
## Example
The example below ingests 5 small data sources of different formats into a graph. It also shows how to query the graph and visualize the results.
#### Ingesting a small dataset:
From the main folder, call the the jar in the core folder with the following options:
From the main folder, call the jar in the `core` folder with the following options:
```
java -jar core/connection-lens-core-full-1.1-SNAPSHOT.jar -DRDBMSDBName=cl_myinstance -i data/poc/2/deputes.json,data/poc/2/fb-etienne-chouard.txt,data/poc/2/medias.txt,data/poc/2/tweet-Ruffin.json,data/poc/2/rt-wikipedia.txt
......@@ -77,34 +74,27 @@ Quotes can be used to denote groups of keywords to consider as an *atomic*
keyword, i.e. a string between quotes will be matched *exactly* against the
graph.
Russie - 1 AT
Ruffin - 13 ATs
Poutine - 1 AT
- Russie - 1 AT
- Ruffin - 13 ATs
- Poutine - 1 AT
- Assemblée - 3 ATs
- Soral Toulon - 2 ATs
- Briand Halluin Tonolli - 1 AT
Assemblée - 3 ATs
Soral Toulon - 2 ATs
Briand Halluin Tonolli - 1 AT
#### Visualization
- Drop the `gui.war` into your tomcat/webapps.
- Drop the `gui.war` into the `webapps` directory under the Tomcat installation.
- Point a browser at adress `http://localhost:8080/gui/`.
- Point a browser at the address `http://localhost:8080/gui/`.
- Select `myinstance` database in the header drop-down menu.
- Select the `myinstance` database in the header drop-down menu.
- Search for any above queries directly on the keyword search bar.
- For example, the following figure shows the result of the query: `Briand Halluin Tonolli`.
- Ask a query, e.g., one of the above, directly on the keyword search bar. For example, the following figure shows the result of the query: `Briand Halluin Tonolli`.
![image_4.png](./image_4.png)
# Contributing to ConnectionLens
If you found a bug or issue with ConnectionLens please let us know. You can report bugs on the [issue](https://gitlab.inria.fr/cedar/connectionlens/-/issues) tracker.
......
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