Browse Source

Updated to identify the specific libraries that need to be installed for things to compile and run properly

Stan Gurtler 1 year ago
parent
commit
5f7aba370d
1 changed files with 3 additions and 3 deletions
  1. 3 3
      README.md

+ 3 - 3
README.md

@@ -13,7 +13,7 @@
 
 ### DHTPIR Simulation
 
-To run an individual run of our simulator, you will need to be in the `./dhtpir_simulation/` directory. From there, run `./test_harness.py <type> <numDocuments> <sizeOfDocuments> <numGroups> <numNodes> --seed [seed]`, with appropriate values for each of these variables.
+To run an individual run of our simulator, you will need Python3 and Numpy installed. You will also need to be in the `./dhtpir_simulation/` directory. From there, run `./test_harness.py <type> <numDocuments> <sizeOfDocuments> <numGroups> <numNodes> --seed [seed]`, with appropriate values for each of these variables.
 
 `<type>` takes one of the following forms, depending on which type of system you intend to simulate:
 - `-b`: "BaseNode", or a basic DHT system with no additional privacy-preserving or secure behaviour of any kind simulated
@@ -34,7 +34,7 @@ To run an individual run of our simulator, you will need to be in the `./dhtpir_
 
 In addition, `./test_harness.py -h` displays a help message similar in content to what is discussed in this README.
 
-There are two other programs in the directory, `options_setup.c` and `run_tests.c`. `options_setup.c` generates a config file used by `run_tests.c` to run several simulation runs simultaneously/in succession. A Makefile is included to compile them (`make all` compiles both, or `make options_setup` / `make run_tests` compiles each individually). No additional installation is necessary beyond gcc . `options_setup` does not take any arguments, and `run_tests` takes one argument, the maximum number of processes it may run simulations inside of simultaneously.
+There are two other programs in the directory, `options_setup.c` and `run_tests.c`. `options_setup.c` generates a config file used by `run_tests.c` to run several simulation runs simultaneously/in succession. A Makefile is included to compile them (`make all` compiles both, or `make options_setup` / `make run_tests` compiles each individually). No additional installation is necessary beyond gcc (and make). `options_setup` does not take any arguments, and `run_tests` takes one argument, the maximum number of processes it may run simulations inside of simultaneously.
 
 ### Cuckoo Simulation
 
@@ -62,7 +62,7 @@ There are additional scripts to binary search for the largest number of maliciou
 
 ## Graphs
 
-The graphs present in the `./plots/` directory are generated by `make_graphs.py`, from output in the `./outputs/` directory, using `plots.json` as a config file for determining text content in the graphs. Simply running `./make_graphs.py` from the `./plots/` directory, so long as `plots.json` has not been altered (or has been altered appropriately to generate new graphs), will generate these graphs.
+The graphs present in the `./plots/` directory are generated by `make_graphs.py`, from output in the `./outputs/` directory, using `plots.json` as a config file for determining text content in the graphs. To run this file for yourself, you will need Python3, Numpy, and Matplotlib installed. With that in place, from the `./plots/` directory, run `./make_graphs.py`, and as long as `plots.json` has not been altered (or has been altered appropriately to generate new graphs), the same graphs will be generated.
 
 The graphs present are organized as follows: `<y-axis>-<x-axis>-<which>.pdf`.