simulating elevators - inspiration
- Fully featured test suite to run automated tests
- Easy to use GUI to allow for manual testing and bug fixing
- Extensible framework to implement new algorithms and tests
- Ability to export and import artefacts for debugging or reproducible testing
- Adjustable simulation speed*
*Simulation speed might not be as relative as one might expect. For example, the jump from 100 to 200 might not be double the speed as there might be other factors such as code computation affecting the slower execution.
Both the GUI and the Test Suite control the same managers and algorithms in the backend. However, there are wrappers to allow for the difference in concurrency type (threading/multiprocessing).
| File | Description |
|---|---|
| gui.py | GUI handler |
| gui | GUI backend |
| suite | Test suite |
| models | Data models for custom classes |
| constants.py | Various enums and constants |
| utils.py | Utility functions |
| errors.py | Custom errors |
- wxPython===4.2.0 (PyPi, official website)
- tqdm===4.65.0 [test suite only] (PyPi)
A custom algorithm can be made by subclassing ElevatorAlgorithm in a file in the algorithms folder.
The name of the file is unimportant. 2 attributes need to be defined in the file, __name__ (str) and __algorithm__ (object) as shown.
When debugging, algorithm.name will be the __name__ attribute.
class MyAlgorithm(ElevatorAlgorithm):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
# custom init code here
def get_new_destination(self, elevator: Elevator) -> int:
# return a integer for the new destination floor
pass
__name__ = "My Custom Algorithm"
__algorithm__ = MyAlgorithmThere are various events exposed for subclasses but the only required function is get_new_destination. Exposed events are listed below.
def pre_loop(self):
def post_loop(self):
def on_load_load(self, load, elevator):
def on_load_unload(self, load, elevator):
def on_elevator_move(self, elevator):
def on_elevator_added(self, elevator):
def on_elevator_removed(self, elevator):
def on_floors_changed(self):
def on_load_added(self, load):
def on_load_removed(self, load):
def on_simulation_end(self, load):There are also 2 check functions that should return a boolean. If the check fails, the load will not be loaded/unloaded.
def pre_load_check(self, load, elevator) -> bool:
def pre_unload_check(self, load, elevator) -> bool:The loop is managed by the ActionQueue which prioritises the actions to be carried out on an elevator. The loop is called once every tick and actions are executed until ADD_TICK.
If there are no actions to be carried out, the elevator will carry out RUN_CYCLE.
| Action | Description |
|---|---|
| ADD_TICK | Adds a tick to the elevator |
| RUN_CYCLE | Runs the elevator cycle |
| MOVE_ELEVATOR | Moves the elevator to the next floor |
| LOAD_LOAD | Loads the load into the elevator |
| UNLOAD_LOAD | Unloads the load from the elevator |
Ticks are only physically added in the algorithm, after the entire elevator's cycle executes and it exits with a ADD_TICK action. This repeats again in the next tick.
For example, a typical action call could be as follows:
RUN_CYCLE
ADD_TICK - 3 # moving elevator
MOVE_ELEVATOR
RUN_CYCLE
ADD_TICK - 3 # door open
LOAD_LOAD
LOAD_LOAD
LOAD_LOAD
ADD_TICK - 1 # 3 loads
LOAD_LOAD
LOAD_LOAD
LOAD_UNLOAD
ADD_TICK - 1 # 3 loads
LOAD_UNLOAD
ADD_TICK - 1 # 3 loads (part thereof)
ADD_TICK - 3 # door close
ADD_TICK - 3 # moving elevator
MOVE_ELEVATOR
GUI events will be triggered upon every configuration change and every tick. Refer to GUI and ElevatorManager >
send_eventfor more information.
A tick is represented by 1 second (assuming 1x speed). The following are rough guidelines of how many ticks each action should take
| Action | Ticks | Remarks |
|---|---|---|
| MOVE_ELEVATOR | 3 | |
| LOAD_LOAD/UNLOAD_LOAD | 1 per 3 loads (or part thereof) | The counter is combined for both loading and unloading loads. |
| OPEN_DOOR | 3 | This is only called when there is at least 1 load to load/unload. |
| CLOSE_DOOR | 3 | This is only called when there is at least 1 load to load/unload. |
The cycle is the main event loop of the elevator. It can be broken down into 3 major parts:
- Remove existing loads
- Add new loads
- Move the elevator
The gui module exposes a WXPython GUI to allow end users to interact with the elevator simulator.
Run python -m gui
The GUI uses a multithreaded approach as per the following explanation:
| Thread | Description |
|---|---|
| Main Thread | Manages the GUI and user input |
| Manager Thread | Manages the elevators and all backend related tasks |
Upon any changes in the manager thread, a wx event is fired to allow for the main thread to update the GUI. This can happen very very often (multiple times per tick) hence it is important to keep the event handlers as lightweight as possible and perform as little layout changes.
The test suite exposes a TestSuite class that takes in TestSettings. This allows the end user to create reproducible tests and feed them in programmatically. Refer to the source code for exact arguments.
Further options can also be fed into the TestSuite class. Refer to the source code for exact arguments.
It is recommended for the name to not be distinguishable to the algorithm and multiple tests (with different algorithms) to have identical names.
Source Code: suite.py
Examples: test_json.py (test.example.json), test_benchmark.py
The test suite runs using a multiprocess approach as per the following explanation:
| Process | Description |
|---|---|
| Main Process | Manages all processes and does final saving of results |
| Background Process | Handles errors raised by test processes and exports artefacts |
N Test Processes |
Runs the test and raises errors to the background process, reports back to main process |
The number of test processes (N) are determined by the following formula:
- <= the given
max_processeskwarg - <= (CPU Count - 1)
- <= Number of total iterations
The processes are then spawned and iterations are run concurrently. Upon any errors raised by the algorithm, it will be passed to the Background Process and the iteration will be skipped. A new process will be spawned to continue the test suite.
Tests are mostly replicable with the given seed. The initial state should be the same but there might be small kinks that could result in slightly varied outcomes. Note that for each seed, the iteration count is also attached to it.
Rough example of what the test suite is capable of. This ran in under 3 minutes (10 iterations each) on a 4 physical core CPU.
SLOW NUM TICK WAIT TIL OCC
-------------------- --- ------------------- ----------------- --------------- -------------
Rolling 10 714.90 (697.00) 295.20 (285.35) 44.19 (38.95) 58.40 (67.33)
Destination Dispatch 10 889.00 (913.50) 353.88 (334.30) 55.40 (50.35) 57.22 (62.00)
Scatter 10 955.10 (956.50) 387.54 (384.25) 74.25 (59.65) 75.16 (84.00)
LOOK 10 1267.40 (1311.50) 519.34 (504.15) 102.95 (88.60) 78.52 (88.67)
NStepLOOK 10 1343.70 (1400.50) 525.12 (478.45) 68.43 (58.35) 49.47 (51.33)
FCFS 10 1552.20 (1569.50) 680.54 (670.45) 75.26 (69.75) 46.25 (46.00)
BUSY NUM TICK WAIT TIL OCC
-------------------- --- ------------------- ----------------- --------------- -------------
Rolling 10 5161.20 (5125.00) 2197.29 (2105.40) 183.15 (155.40) 68.51 (92.00)
Destination Dispatch 10 5364.70 (5459.00) 2159.20 (2063.25) 172.26 (159.20) 60.34 (68.00)
Scatter 10 8144.80 (8166.50) 3453.09 (3427.00) 354.35 (242.15) 85.22 (98.67)
LOOK 10 8264.10 (8197.00) 3609.78 (3591.35) 367.68 (306.55) 88.06 (98.67)
NStepLOOK 10 12005.00 (12145.50) 4507.09 (4395.95) 183.98 (157.45) 29.77 (14.67)
FCFS 10 13627.00 (13976.50) 5957.50 (5818.15) 243.40 (213.35) 34.09 (24.67)