Skip to content

Commit

Permalink
add pipenv req
Browse files Browse the repository at this point in the history
  • Loading branch information
kunterbunt committed Jun 27, 2023
1 parent 4dd124a commit d09f50a
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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`.
Expand Down

0 comments on commit d09f50a

Please sign in to comment.