From 7880df025fad5985d103abd86ec40c9ba8ff77af Mon Sep 17 00:00:00 2001 From: Loic Guegan Date: Thu, 21 Mar 2024 11:17:41 +0100 Subject: Update README --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9f5c4f3..37b7ecf 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ ESDS is part of a research project. Studies and validation experiments are avail ### Installation `> pip install esds` -To ensure that esds is properly working and installed on your system, you can run the simulation tests with one of the following scripts: +To ensure that esds is properly working and installed on your system, you can clone this repository, and run the simulation tests with one of the following scripts: - `tests/run.sh` - `tests/run.py` @@ -19,8 +19,8 @@ To ensure that esds is properly working and installed on your system, you can ru - Small API - 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) +- Node mobility (through dynamic updates of the network matrices) +- Node plugins (e.g: energy consumption) ### What ESDS does not implements ? - Network protocols (e.g IP/TCP/UDP) @@ -40,7 +40,9 @@ To ensure that esds is properly working and installed on your system, you can ru - `api.read()` - `api.turn_on()` - `api.turn_off()` -- *More details on the API in [example/sender.py](example/sender.py)* +- More detailed examples are available here: + - [example/sender.py](https://gitlab.com/manzerbredes/esds/-/blob/main/example/sender.py) + - [example/receiver.py](https://gitlab.com/manzerbredes/esds/-/blob/main/example/receiver.py) ### Documentation -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 +The documentation of ESDS is available in the [user manual](https://gitlab.com/manzerbredes/esds/-/blob/main/manual/manual.pdf). -- cgit v1.2.3