Merge pull request #39 from prrao87/update-visualization

Update visualization with Kùzu Explorer image
prrao87 · Jun 18, 2024 · 9f30f05 · 9f30f05
2 parents 4fd110c + 87a9d0d
commit 9f30f05
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 2 deletions.
diff --git a/assets/person-person.png b/assets/person-person.png
diff --git a/kuzudb/README.md b/kuzudb/README.md
@@ -17,7 +17,18 @@ The script `build_graph.py` contains the necessary methods to connect to the Kù
 python build_graph.py --batch_size 50000
 ```
 
-### Ingestion performance
+## Visualize graph
+
+The provided `docker-compose.yml` allows you to run [Kùzu Explorer](https://github.com/kuzudb/explorer), an open source visualization
+tool for KùzuDB. To run the Kùzu Explorer, install Docker and run the following command:
+
+```sh
+dockercompose up
+```
+
+This allows you to access to visualize the graph on the browser at `http://localhost:8000`.
+
+## Ingestion performance
 
 The numbers shown below are for when we ingest 100K person nodes, ~10K location nodes and ~2.4M edges into the graph.
 

diff --git a/kuzudb/docker-compose.yml b/kuzudb/docker-compose.yml
@@ -0,0 +1,10 @@
+services:
+  explorer:
+    image: kuzudb/explorer:latest
+    restart: unless-stopped
+    environment:
+      - MODE=READ_ONLY
+    ports:
+      - 8000:8000
+    volumes:
+      - ./social_network:/database
diff --git a/neo4j/README.md b/neo4j/README.md
@@ -33,7 +33,11 @@ The script `build_graph.py` contains the necessary methods to connect to the Neo
 python build_graph.py
 ```
 
-### Ingestion performance
+## Visualize graph
+
+You can visualize the graph in the Neo4j browser by a) downloading the Neo4j Desktop tool, or b) in the browser via `http://localhost:7474`.
+
+## Ingestion performance
 
 The numbers shown below are for when we ingest 100K person nodes, ~10K location nodes and ~2.
 4M edges into the graph. Note the following points: