Major refactoring:

- Create pip package
- Reorganized source code

.gitignore

@@ -1,2 +1,4 @@
 __pycache__
 esds.debug
+dist
+esds.egg*

README.md

@@ -2,12 +2,15 @@
 # ESDS: An Extensible Simulator For Distributed Systems and Cyber-Physical Systems
 [![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 ?**
+### 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/`

esds/__init__.py

@@ -0,0 +1,3 @@
+__all__ = ["simulator", "plugins"]
+
+from esds.esds import Simulator

example/simulator.py

@@ -2,7 +2,6 @@
 
 # Load ESDS
 import sys
-sys.path.append("../")
 import esds
 
 # Use numpy to construct bandwidth and latencies matrix

pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"

setup.cfg

@@ -0,0 +1,11 @@
+[metadata]
+name = esds
+version = 0.0.1
+author = Loic Guegan
+maintainer = Loic Guegan
+description = Extensible Simulator of Distributed Systems
+keywords = simulator, distributed systems, cyber-physical systems, network, wireless, wired
+license = GNU LGPLv3
+
+[options]
+install_requires = numpy >= 1.22.4

tests/hidden_node_2s1r/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/mobility_eth0_bandwidth_1s1r/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/mobility_eth0_bandwidth_2s1r/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/mobility_eth0_latency_1s1r/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/mobility_eth0_latency_2s1r/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/mobility_wlan0_bandwidth_1s1r/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/mobility_wlan0_latency_1s1r/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/simple_breakpoints_auto_1n/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/simple_breakpoints_manual_1n/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/simple_breakpoints_manual_no_callback_1n/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/simple_log_5n/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/simple_read_clock_2n/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/simple_read_eth0_ncom_2s1r/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/simple_read_wlan0_ncom_2s1r/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/simple_receivet_eth0_1s1r/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/simple_send_4interfaces_1s2r/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/simple_send_eth0_1s1r/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/simple_send_eth0_2s1r/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/simple_send_eth0_3s1r/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/simple_send_wlan0_1s2r/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/simple_send_wlan0_2s1r/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/simple_sendt_eth0_1s1r/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/simple_sendt_wlan0_1s2r/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/simple_wait_2n/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np
 

tests/simple_wait_end_3n/simulator.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
 # Load ESDS
-import sys
-sys.path.append("../../")
 import esds
 import numpy as np