summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md27
1 files changed, 16 insertions, 11 deletions
diff --git a/README.md b/README.md
index 4d6de84..37349b8 100644
--- a/README.md
+++ b/README.md
@@ -2,18 +2,23 @@
# ESDS: An Extensible Simulator For Distributed Systems and Cyber-Physical Systems
**What is ESDS ?**
-It is a short learning curve and coarse-grain network simulator. It contains the essential building blocks for the simulation of *Cyber-Physical Systems* (CPS) and *Wireless Sensors Networks* (WSN) scenarios. It was originally designed to improve node implementation flexibility/faithfulness and mitigate the learning curve compare to existing network simulators.
+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 node implementation flexibility/faithfulness and mitigate the learning curve compare to existing network simulators.
-**What ESDS does not implements?**
-- Network protocols (such as IP/TCP/UDP)
-- Wireless physical layer models
-- Routing algorithms
-- And much more!
+ESDS is part of a research project. Thus, studies and validation experiments are available online. For more details please visit http://todo.com.
**Features:**
-- The implementation of node behavior can be any python file that you have wrote
-- Wireless interferences detection (not modelization)
-- Simulation can be interrupted at constant intervals to perform custom actions (such as implement nodes mobility)
+- Easy to use
+- Small API
+- Agent-based: node implementations are 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)
+
+**What ESDS does not implements (yet?) ?**
+- 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)
+- And much more!
**Current API:**
- `api.args`
@@ -27,6 +32,6 @@ It is a short learning curve and coarse-grain network simulator. It contains the
- `api.read(<register>)`
- `api.turn_on()`
- `api.turn_off()`
-- *More details in [example/sender.py](example/sender.py)*
+- *More details on the API in [example/sender.py](example/sender.py)*
-**Documentation:** cf. `example/` and `tests/`
+**Documentation:** see `example/` and `tests/`