diff options
| author | Loïc Guégan <loic.guegan@mailbox.org> | 2025-09-19 10:41:19 +0200 |
|---|---|---|
| committer | Loïc Guégan <loic.guegan@mailbox.org> | 2025-09-19 10:41:19 +0200 |
| commit | 284cee3f032bed1243f0d1256d394e9458132075 (patch) | |
| tree | 613066feb20a4d45c8fbd5c102a329298b4a1a66 | |
| parent | 1ff11712d1d49cd166e2df44b850ac6fecaf6f49 (diff) | |
Improve readme
| -rw-r--r-- | README.md | 12 | ||||
| -rw-r--r-- | simulations/README.md | 18 |
2 files changed, 20 insertions, 10 deletions
@@ -1,9 +1,17 @@ # loosely-policies-analytics -Analysis folder: +## Analysis folder - learning.R: contains two major functions: - build_models: To generate K-fold cross-validation results (note that hyper-parameters for decisions tree is fixed (no validation set)) - generate_inputs: generate the inputs for the simulations experiments + the decision tree plots - days.R: Implement the in-situ learning approach -To fix: remove minbucket=1 (does not impact the results) +Todo: remove minbucket=1 (does not impact the results) + +## Simulation folder + +- 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 diff --git a/simulations/README.md b/simulations/README.md index 627c787..32ad38c 100644 --- a/simulations/README.md +++ b/simulations/README.md @@ -1,17 +1,19 @@ # Impact of loosely coupled data dissemination policies for resource challenged environements ### Setup -- First you need [Boost](https://www.boost.org/) -- From the project root folder run `cd ./libs && ./setup.sh && cd -` -- And `make` -- If the project compiles successfully, you are ready to run the simulations! +- 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 - 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 + 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 -- The file `inputs.json` controls the inputs to the simulator. You should only care about this file -if you want custom 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: `make run 2>&1|./parser.awk` |