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

Update README

Browse source
This commit is contained in:
Loïc Guégan 2024-03-21 11:17:41 +01:00
parent 5c806e06bd
commit 7880df025f
2 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -10,7 +10,7 @@ ESDS is part of a research project. Studies and validation experiments are avail
### Installation ### Installation
`> pip install esds` `> 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.sh`
- `tests/run.py` - `tests/run.py`
@ -19,8 +19,8 @@ To ensure that esds is properly working and installed on your system, you can ru
- Small API - Small API
- Agent-based: node implementations are located in dedicated python files - Agent-based: node implementations are located in dedicated python files
- Wireless interferences detection (i.e not modelization) - Wireless interferences detection (i.e not modelization)
- Node mobility (by updating the network matrices) - Node mobility (through dynamic updates of the network matrices)
- Nodes plugins (e.g: energy consumption) - Node plugins (e.g: energy consumption)
### What ESDS does not implements ? ### What ESDS does not implements ?
- Network protocols (e.g IP/TCP/UDP) - 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.read(<register>)`
- `api.turn_on()` - `api.turn_on()`
- `api.turn_off()` - `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 ### Documentation
The documentation of ESDS is available in the [user manual](https://gitlab.com/manzerbredes/esds/-/blob/main/manual/manual.pdf). The documentation of ESDS is available in the [user manual](https://gitlab.com/manzerbredes/esds/-/blob/main/manual/manual.pdf).

2
esds/__init__.py
View file

@ -1,5 +1,5 @@
__all__ = ["simulator", "node", "plugins", "helpers", "rcode", "debug", "platform"] __all__ = ["simulator", "node", "plugins", "helpers", "rcode", "debug", "platform"]
__version__ = "0.0.7" __version__ = "0.0.8"
from esds.simulator import Simulator from esds.simulator import Simulator
from esds.rcode import RCode from esds.rcode import RCode