summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLoic Guegan <manzerbredes@mailbox.org>2022-09-02 10:01:16 +0200
committerLoic Guegan <manzerbredes@mailbox.org>2022-09-02 10:01:16 +0200
commitc73ebc1fbc4ccae6b2ddcedf529f4f65234bfc33 (patch)
tree213d015023224de9e9e49be7f78e76011dde4f90
parentf6fc8a4c86fb483c486f4f9f387470fa04d67f66 (diff)
Cleaning
-rw-r--r--README.md10
-rwxr-xr-xtests/run.py12
2 files changed, 11 insertions, 11 deletions
diff --git a/README.md b/README.md
index 5a9a028..cc02513 100644
--- a/README.md
+++ b/README.md
@@ -3,21 +3,21 @@
[![Dependency](https://img.shields.io/badge/Python-v3.10-blue)](https://www.python.org/) [![Pipeline](https://gitlab.com/manzerbredes/esds/badges/main/pipeline.svg)](https://gitlab.com/manzerbredes/esds/-/tree/main)
### 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.
+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 the flexibility/faithfulness of nodes implementations 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.
+ESDS is part of a research project. Studies and validation experiments are available online. For more details please visit http://todo.com.
### Installation
`> pip install esds`
-To ensure that esds is properly working and installed on your system, you can run the simulations tests with one of the following scripts:
+To ensure that esds is properly working and installed on your system, you can run the simulation tests with one of the following scripts:
- `tests/run.sh`
- `tests/run.py`
### Features
- Easy to use
- Small API
-- Agent-based: node implementations are in independant python files
+- Agent-based: node implementations are located 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)
@@ -43,4 +43,4 @@ To ensure that esds is properly working and installed on your system, you can ru
- *More details on the API in [example/sender.py](example/sender.py)*
### Documentation
-See `example/`, `tests/` and `manual/manual.pdf`
+See `manual/manual.pdf` and the source code in `example/` and`tests/`.
diff --git a/tests/run.py b/tests/run.py
index 9c21881..0af8d1c 100755
--- a/tests/run.py
+++ b/tests/run.py
@@ -1,12 +1,12 @@
#!/usr/bin/env python
-import os, subprocess, time,sys
+import os,subprocess,time,sys
-##### Setup Variables
+##### Setup variables
tests_timeout=20 # Max duration of a test
tests_path = os.path.dirname(os.path.realpath(__file__))
-##### Run All Tests
+##### Run all tests
for file in os.listdir(tests_path):
current_test_path=os.path.join(tests_path,file)
if os.path.isdir(current_test_path):
@@ -15,7 +15,7 @@ for file in os.listdir(tests_path):
print("- %-40s%s " % (file,"=>"),end='')
try:
start_at=time.time()
- out=subprocess.check_output([sys.executable, simulator_path], stderr=subprocess.STDOUT,timeout=tests_timeout,encoding="utf-8")
+ out=subprocess.check_output([sys.executable, simulator_path],stderr=subprocess.STDOUT,timeout=tests_timeout,encoding="utf-8")
out_expected=open(out_path).read()
end_at=time.time()
if out_expected != out:
@@ -28,12 +28,12 @@ for file in os.listdir(tests_path):
print("passed (%0.1fs)"%(end_at-start_at))
except subprocess.TimeoutExpired as err:
print("failed :(")
- print("------------- Test timeout (should not exceed "+str(tests_timeout)+"s) -------------")
+ print("------------- Test duration expired (timeout="+str(tests_timeout)+"s) -------------")
print(err.output,end="")
exit(1)
except subprocess.CalledProcessError as err:
print("failed :(")
- print("------------- Non test has a non-zero exit code -------------")
+ print("------------- Test has a non-zero exit code -------------")
print(err.output,end="")
exit(2)
except Exception as err: