loic/esds
1
0
Fork 0
mirror of https://gitlab.com/manzerbredes/esds.git synced 2025-04-07 02:26:28 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README with more informations

Browse source
This commit is contained in:
Loic Guegan 2022-06-10 09:24:30 +02:00
parent d9e70b498b
commit ab702d1253
1 changed files with 16 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -2,18 +2,23 @@
# ESDS: An Extensible Simulator For Distributed Systems and Cyber-Physical Systems # ESDS: An Extensible Simulator For Distributed Systems and Cyber-Physical Systems
**What is ESDS ?** **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?** ESDS is part of a research project. Thus, studies and validation experiments are available online. For more details please visit http://todo.com.
- Network protocols (such as IP/TCP/UDP)
- Wireless physical layer models
- Routing algorithms
- And much more!
**Features:** **Features:**
- The implementation of node behavior can be any python file that you have wrote - Easy to use
- Wireless interferences detection (not modelization) - Small API
- Simulation can be interrupted at constant intervals to perform custom actions (such as implement nodes mobility) - 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:** **Current API:**
- `api.args` - `api.args`
@ -27,6 +32,6 @@ It is a short learning curve and coarse-grain network simulator. It contains the
- `api.read(<register>)` - `api.read(<register>)`
- `api.turn_on()` - `api.turn_on()`
- `api.turn_off()` - `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/`