Skip to content

Commit 4df7978

Browse files
committed
README.ms updated
1 parent a581ca4 commit 4df7978

1 file changed

Lines changed: 16 additions & 15 deletions

File tree

README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Arena3D
88

9-
> Fully interactive, dependency-free 3D visualization of multilayered networks.
9+
> Interactive 3D visualization of multilayered networks.
1010
1111
---
1212

@@ -15,7 +15,6 @@
1515
1. [Overview](#overview)
1616
2. [Key Features](#key-features)
1717
3. [Getting Started](#getting-started)
18-
1918
* [Online Demo](#online-demo)
2019
* [Local Installation](#local-installation)
2120
4. [Example Data](#example-data)
@@ -27,20 +26,20 @@
2726

2827
## 📝 Overview
2928

30-
Arena3D is a web application for visualizing multilayered graphs in 3D space. It pairs a **FastAPI** backend (Python + python-igraph for layouts, clustering, and topology metrics) with a **Vite / TypeScript / Three.js** frontend. Integrate multiple networks into a single scene, explore intra- and inter-layer connections, and manipulate the view in real time.
29+
Arena3D is a web application for visualizing multilayered graphs in 3D space. It pairs a **FastAPI** backend (Python + python-igraph for layouts, clustering, and topology metrics) with a **Vite / TypeScript / Three.js** frontend. Use it to integrate multiple networks into a single scene, explore intra- and inter-layer connections, and manipulate the view in real time.
3130

3231
---
3332

3433
## 🚀 Key Features
3534

36-
* **Multi-layer integration**: Load and combine multiple network layers with cross-layer edges.
37-
* **3D Interactivity**: Translate, rotate, and scale the scene or individual layers.
35+
* **Multilayer integration**: Load and combine multiple network layers with cross-layer edges.
36+
* **3D interactivity**: Translate, rotate, and scale the scene or individual layers.
3837
* **Rich layouts & clustering**: Apply and customize 11 layouts (force-directed, circular, grid, …) and 4 clustering algorithms on selected layers.
39-
* **Dynamic styling**: Adjust node size, color, and edge colors on-the-fly to highlight important paths or topological features; upload node/edge attribute files.
40-
* **Themes & export**: Choose from premade themes; export/import sessions in JSON.
38+
* **Dynamic styling**: Adjust node size, color, and edge colors on the fly to highlight important paths or topological features; upload node/edge attribute files.
39+
* **Themes & export**: Choose from predefined themes; export/import sessions in JSON.
4140
* **Undo/redo**: Every scene mutation is undoable.
4241
* **Graph support**: Handle weighted/unweighted, directed/undirected, and multi-channel graphs up to 10,000 edges (online); unlimited locally.
43-
* **API access**: Open networks directly from external applications via REST endpoint.
42+
* **API access**: Open networks directly from external applications via the REST API.
4443

4544
---
4645

@@ -60,7 +59,7 @@ cd Arena3D
6059
docker-compose up # builds + runs backend (8000) and frontend (5173)
6160
```
6261

63-
For a single production image (nginx serving the built frontend + uvicorn):
62+
For a single production image (nginx serving the built frontend + Uvicorn):
6463

6564
```bash
6665
docker build -t arena3d .
@@ -106,14 +105,16 @@ npm run dev # http://localhost:5173 (/api proxied to
106105

107106
## 📚 Citing Arena3D
108107

109-
* **Arena3D<sup>web</sup>: interactive 3D visualization of multilayered networks**
110-
Karatzas E., Baltoumas F.A., Panayiotou N.A., Schneider R., Pavlopoulos G.A.
111-
*Nucleic Acids Research*, 2021;49(W1)\:W36–W45.
108+
The following publications refer to Arena3D under its former name, Arena3Dweb.
109+
110+
* **Arena3D<sup>web</sup>: interactive 3D visualization of multilayered networks**
111+
Karatzas E., Baltoumas F.A., Panayiotou N.A., Schneider R., Pavlopoulos G.A.
112+
*Nucleic Acids Research*, 2021;49(W1):W36-W45.
112113
doi: [10.1093/nar/gkab278](https://doi.org/10.1093/nar/gkab278)
113114

114-
* **Arena3D<sup>web</sup>: interactive 3D visualization of multilayered networks supporting multiple directional information channels, clustering analysis and application integration**
115-
Kokoli M., Karatzas E., Baltoumas F.A., Schneider R., Pafilis E., Paragkamian S., Doncheva N.T., Jensen L.J., Pavlopoulos G.A.
116-
*NAR Genomics and Bioinformatics*, 2022;5(2)\:lqad053.
115+
* **Arena3D<sup>web</sup>: interactive 3D visualization of multilayered networks supporting multiple directional information channels, clustering analysis and application integration**
116+
Kokoli M., Karatzas E., Baltoumas F.A., Schneider R., Pafilis E., Paragkamian S., Doncheva N.T., Jensen L.J., Pavlopoulos G.A.
117+
*NAR Genomics and Bioinformatics*, 2022;5(2):lqad053.
117118
doi: [10.1093/nargab/lqad053](https://doi.org/10.1093/nargab/lqad053)
118119

119120
---

0 commit comments

Comments
 (0)