summaryrefslogtreecommitdiff
path: root/simulations/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'simulations/README.md')
-rw-r--r--simulations/README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/simulations/README.md b/simulations/README.md
index 32ad38c..1f7baad 100644
--- a/simulations/README.md
+++ b/simulations/README.md
@@ -1,18 +1,24 @@
# Impact of loosely coupled data dissemination policies for resource challenged environements
-### Setup
+## Folders
+- src/: contains the simulator code (based on SimGrid)
+- libs/: contains a setup script that will fetch and configure the correct SimGrid version
+ - see simulation/README.md for more info
+- results/: Contains all needed script to run the experiments
+ - In particular paper.sh generates the results present in the paper
+## Setup
- First you need [Boost](https://www.boost.org/)
- Then setup SimGrid with `cd ./libs && ./setup.sh && cd -`
- Then run `make` in this folder to compile the simulator code
- If the project compiles successfully, you are ready to execute the simulations!
-### Paper's Simulations
+## Paper's Simulations
- To run all the simulations presented in the paper simply run `./results/paper.sh`
this will create the file `results/results.csv` containing all the results. This will also create an
`inputs.json` that you can modify at your convenience
- Note: `inputs.json` file is generated by `src/scenarios.cc` (see paper.sh to see how it is used)
- The idea of scenarios.cc is to generate a random node schedule (turn_on and turn_off cycles) based on the various suppplied arguments
- Then, `simulator.cc` can use this `inputs.json` (via `Inputs.cc`) to simulate those cycles
-### Simulations
+## Simulations
- The file `inputs.json` controls the inputs to the simulator. You should only care about this file if you want custom simulations
- To run the simulation just run `make run` This will also generate a file called `platform.xml` corresponding to the simulated platform
- To generate a *csv* output from the simulation results you can use: