diff --git a/README.md b/README.md index bece0decad847eb2bd492062c11c5948689d86e9..6cf083a3b9ae149f30c5db2d18af61ffffbd347e 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,23 @@ The owner (and main contributor) of this repo is Nils Vreman. Collaborators: Richard Pates, Kristin Krüger, Gerhard Fohler, Martina Maggio. +## Running tests + +### Packages +To be able to run this benchmark test, aside from __python3.6__, two packages are needed: +1. numpy +2. ortools + +These packages can easily be installed with the commands: + pip3 install numpy + pip3 install ortools + +### Execution +After installing necessary packages, the benchmark test could be executed using +the __Makefile__ placed in the Code directory. It will create a directory called +"data" containing all the results and corresponding tasksets. The class +__FileSystemManager__ is then used to access the results. + ## Navigation ### Code @@ -34,7 +51,7 @@ found. Each page in the pdf-file contains the results from the experiments performed on a certain maximum hyperperiod (written as a title in the top left corner of each side). Each figure then represents a specific number of tasks in each taskset of that experiment. The results written in red boxes is the -accurracy of the algorithm, i.e., for how large fraction of the tasksets our algorithm +accuracy of the algorithm, i.e., for how large fraction of the tasksets our algorithm found an optimal schedule set within 60 minutes. This is also summarized in the table below.