Skip to content

Commit 802b5d3

Browse files
committed
Update README with guide to repo
1 parent 415d125 commit 802b5d3

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,25 @@ Since the original submission, we have made several improvements to Alloy that m
393393

394394
This section will be updated with further details as the artefact evaluation progresses.
395395

396+
## A brief guide to the experiment process
397+
398+
The `Makefile` serves as the entry point to the experiment. Whether you choose
399+
to run experiments inside Docker or on bare metal, it firsts downloads Alloy,
400+
checks out a fixed version of it, and builds several configurations for the
401+
different experiments. These binaries are stored in `artefacts/bin/alloy/`.
402+
403+
Next, each benchmark is downloaded, checked out to a fixed version, and
404+
compiled with the different Alloy configurations. Some benchmarks include
405+
harnesses which are part of this repo itself instead of downloaded, these can
406+
be found in `src/`. Some benchmark variants uses patches found in `patch/`
407+
which are automatically applied. The patches are named accordingly, identifying
408+
which experiment variant they belong to. The resulting binaries are placed in
409+
`artefacts/bin/benchmarks/`.
410+
411+
Once all binaries are prepared, ReBench is used to run the experiments, with
412+
raw data saved to `results/`. The data is then processed and visualized using
413+
Python scripts, most of which are organized as Invoke tasks. The final plots
414+
are written to `plots/`, ready for direct inclusion in the paper.
396415

397416
## Appendix: Installing Docker on Debian
398417

@@ -418,3 +437,4 @@ sudo docker run hello-world
418437
```
419438

420439
See [Docker’s official docs](https://docs.docker.com/engine/install/debian/) for troubleshooting.
440+

0 commit comments

Comments
 (0)