diff options
| author | Loic Guegan <loic.guegan@mailbox.org> | 2024-03-21 11:17:41 +0100 |
|---|---|---|
| committer | Loic Guegan <loic.guegan@mailbox.org> | 2024-03-21 11:17:41 +0100 |
| commit | 7880df025fad5985d103abd86ec40c9ba8ff77af (patch) | |
| tree | daf0bf6fc2f2305a06ea95302c5e8efee3750e1e | |
| parent | 5c806e06bde29b65debba709dbfd014c7e08dd2c (diff) | |
Update README
| -rw-r--r-- | README.md | 12 | ||||
| -rw-r--r-- | esds/__init__.py | 2 |
2 files changed, 8 insertions, 6 deletions
@@ -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(<register>)` - `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). diff --git a/esds/__init__.py b/esds/__init__.py index d6c4c16..975bea7 100644 --- a/esds/__init__.py +++ b/esds/__init__.py @@ -1,5 +1,5 @@ __all__ = ["simulator", "node", "plugins", "helpers", "rcode", "debug", "platform"] -__version__ = "0.0.7" +__version__ = "0.0.8" from esds.simulator import Simulator from esds.rcode import RCode |