Browse Source

Add tl;dr section to the README.md file

Ian Goldberg 4 years ago
parent
commit
816ee9bae6
1 changed files with 14 additions and 0 deletions
  1. 14 0
      README.md

+ 14 - 0
README.md

@@ -16,6 +16,20 @@ In this repository, you will find:
   * **analysis**: a directory containing scripts to analyze the log files produced by the simulator and generate graphs in PDF form.  See [Analyzing the results](#analyzing-the-results) below for more information.
   * **logs**: a directory containing the logs output by the simulator when _we_ ran it.  These are the very logfiles that were processed by the [parselogs.py](analysis/parselogs.py) and [plotdats.py](analysis/plotdats.py) scripts to produce the graphs in the paper.  (When you run the simulator yourself, your log files will end up in a directory called **logdir** that will be created by **run-docker**.)
 
+## tl;dr
+
+  * `./build-docker`
+  * `./run-docker`
+  * Edit the **logdir/run_sims** file to uncomment the simulations you want to run in parallel, noting the memory requirements of each simulation noted in that file.
+  * `./attach-docker`
+  * Inside the docker container:
+    * `logdir/run_sims`
+    * Wait for the simulations to finish
+    * `cd logdir`
+    * `../analysis/parselogs.py *.log`
+    * `../analysis/plotdots.py`
+    * `exit`
+
 ## Building the simulator
 
 The simulator is written in Python, so you don't strictly have to build it per se.  However, for convenience, compatibility, and reproduceability, we provide a docker environment that is all set up so that you can run the simulator.