summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLoic Guegan <manzerbredes@mailbox.org>2023-06-29 11:39:49 +0200
committerLoic Guegan <manzerbredes@mailbox.org>2023-06-29 11:39:49 +0200
commita597b6b91eee353bbf6a8776a7889c2f9f70d6d9 (patch)
treee892291d11697c39b1f02f5a6428a36337017e30
parentee57a1f4e209d12e2a00eba4b1c8c461e2ac28c3 (diff)
Update README.md
-rw-r--r--README.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/README.md b/README.md
index cc02513..9f5c4f3 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
[![Dependency](https://img.shields.io/badge/Python-v3.10-blue)](https://www.python.org/) [![Pipeline](https://gitlab.com/manzerbredes/esds/badges/main/pipeline.svg)](https://gitlab.com/manzerbredes/esds/-/tree/main)
### What is ESDS ?
-It is a short learning curve and coarse-grain network simulator. It contains the essential building blocks for the simulation of *Distributed Systems*, *Cyber-Physical Systems* (CPS), *Wireless Sensors Networks* (WSN) scenarios. It was originally designed to improve the flexibility/faithfulness of nodes implementations and mitigate the learning curve compare to existing network simulators.
+It is a short learning curve and coarse-grain simulator for distributed systems. ESDS contains the building blocks for the simulation of *Distributed Systems*, *Cyber-Physical Systems* (CPS), *Wireless Sensors Networks* (WSN) etc. It is designed to improve the flexibility/faithfulness of nodes implementations and mitigate the learning curve compare to existing simulators.
ESDS is part of a research project. Studies and validation experiments are available online. For more details please visit http://todo.com.
@@ -17,15 +17,15 @@ To ensure that esds is properly working and installed on your system, you can ru
### Features
- Easy to use
- Small API
-- Agent-based: node implementations are located in independant python files
-- Wireless interferences detection (i.e no modelization)
-- Custom node mobility (by updating the network matrix)
-- Nodes plugins (e.g energy consumption)
+- Agent-based: node implementations are located in dedicated python files
+- Wireless interferences detection (i.e not modelization)
+- Node mobility (by updating the network matrices)
+- Nodes plugins (e.g: energy consumption)
### What ESDS does not implements ?
- Network protocols (e.g IP/TCP/UDP)
-- Wireless physical layer models (e.g Friis and Log-Distance models, modulation, RSSI)
-- Routing algorithms (e.g Shortest path)
+- Wireless physical layer models (e.g: Friis and Log-Distance models, modulation, RSSI)
+- Routing algorithms (e.g: Shortest path)
- And much more!
### Simulation API
@@ -43,4 +43,4 @@ To ensure that esds is properly working and installed on your system, you can ru
- *More details on the API in [example/sender.py](example/sender.py)*
### Documentation
-See `manual/manual.pdf` and the source code in `example/` and`tests/`.
+The documentation of ESDS is available in the [user manual](https://gitlab.com/manzerbredes/esds/-/blob/main/manual/manual.pdf). \ No newline at end of file