diff options
| author | Loic Guegan <manzerbredes@mailbox.org> | 2022-06-14 17:13:46 +0200 |
|---|---|---|
| committer | Loic Guegan <manzerbredes@mailbox.org> | 2022-06-14 17:13:46 +0200 |
| commit | 7f13c95e16a802d0706e9f5a6d5d845d7fd67631 (patch) | |
| tree | 65cb3c0faec397cb1b06894645d060514f6b242d /README.md | |
| parent | b6877cb81e56c3991d0dbcf9fa579f627a4c2a29 (diff) | |
Major refactoring:
- Create pip package
- Reorganized source code
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 9 insertions, 5 deletions
@@ -2,12 +2,15 @@ # ESDS: An Extensible Simulator For Distributed Systems and Cyber-Physical Systems [](https://www.python.org/) [](https://gitlab.com/manzerbredes/esds/-/tree/main) -**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 *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. ESDS is part of a research project. Thus, studies and validation experiments are available online. For more details please visit http://todo.com. -**Features:** +### Installation +`> pip install esds` + +### Features - Easy to use - Small API - Agent-based: node implementations are in independant python files @@ -15,13 +18,13 @@ ESDS is part of a research project. Thus, studies and validation experiments are - Custom node mobility (by updating the network matrix) - Nodes plugins (e.g energy consumption) -**What ESDS does not implements (yet?) ?** +### 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) - And much more! -**Current API:** +### Simulation API - `api.args` - `api.send(<int>,<data>,<size>,<dst>)` - `api.sendt(<int>,<data>,<size>,<dst>,<t>)` @@ -35,4 +38,5 @@ ESDS is part of a research project. Thus, studies and validation experiments are - `api.turn_off()` - *More details on the API in [example/sender.py](example/sender.py)* -**Documentation:** see `example/` and `tests/` +### Documentation +See `example/` and `tests/` |