From d09f50afa7323b88213c05fd759d58e9ece76e52 Mon Sep 17 00:00:00 2001 From: Sebastian Lindner Date: Tue, 27 Jun 2023 10:39:32 +0200 Subject: [PATCH] add pipenv req --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2ba827b..cda1d2a 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ A wrapper integrates the different components into OMNeT++. All result evaluation and plotting is done with Python. # Installation -tl;dr: open `install.sh` and adjust the number of cores `NUM_CPUS` to use for compiling; then run `./install.sh` if you're on Linux or `./install.sh mac` if you're on Mac. +tl;dr: install `pipenv` on your system, open `install.sh` and adjust the number of cores `NUM_CPUS` to use for compiling; then run `./install.sh` if you're on Linux or `./install.sh mac` if you're on Mac. Long version: all simulator components are bundled together into one installation script `install.sh`. By passing `mac` as an argument to the install script, it downloads the Mac version of the OMNeT++ simulator instead of the Linux version; this is the only difference between Linux and Mac versions of this simulator. @@ -38,6 +38,9 @@ For example, it downloads the OMNeT++ simulator of the right version from GitHub If this download via `wget` doesn't succeed, for example because GitHub's servers are beyond their capacity (you'll get a `503` error), then later parts of the script fail. This is a very simple Bash script, so peek inside, it's easy to understand, and there's no error recovery built-in, so please debug using common sense! +Result parsing and graph generation is done using Python in respective scripts in `scenarios/results/`. +The packages that are required for this are installed in local `pipenv` environments, so make sure that you have `pipenv` available on your system! + ## Debug mode By default, the simulator is compiled in release mode so that simulations run faster. To compile in debug mode, respective lines are commented-out in the `install.sh`.