notes on how to reproduce

3 files changed, 25 insertions, 17 deletions

diff --git a/analysis/Justfile b/analysis/Justfile
index 8200fed..46cce51 100644
--- a/analysis/Justfile
+++ b/analysis/Justfile
@@ -1,21 +1,18 @@
 default:
   livebook server
 
-fetch-log job outp="current":
-  mkdir -p {{justfile_directory()}}/{{outp}}
-  curl https://git.tardisproject.uk/tcmal/dissertation/-/jobs/{{job}}/raw >> {{justfile_directory()}}/{{outp}}/log
+split-log job outp="current":
   ./split-log.py {{justfile_directory()}}/{{outp}}/log
-  grep -R -H -i 'error' {{justfile_directory()}}/{{outp}}/sections/
 
 fetch-cost-models outp="current":
   mkdir -p {{justfile_directory()}}/{{outp}}
   rm -fr {{justfile_directory()}}/{{outp}}/candelabra
-  rsync -ravP candelabra:/opt/candelabra/src/target/candelabra/ {{justfile_directory()}}/{{outp}}/candelabra
+  rsync -ravP ../src/target/candelabra/ {{justfile_directory()}}/{{outp}}/candelabra
 
 fetch-comparisons outp="current":
   mkdir -p {{justfile_directory()}}/{{outp}}
   rm -fr {{justfile_directory()}}/{{outp}}/criterion
-  rsync -ravP candelabra:/opt/candelabra/src/tests/target/criterion/ {{justfile_directory()}}/{{outp}}/criterion
+  rsync -ravP ../src/tests/target/criterion/ {{justfile_directory()}}/{{outp}}/criterion
   rm -rf {{justfile_directory()}}/{{outp}}/criterion/report
   find {{justfile_directory()}}/{{outp}}/criterion -iname '*.svg' -exec rm '{}' \;
   find {{justfile_directory()}}/{{outp}}/criterion -iname '*.html' -exec rm '{}' \;
diff --git a/analysis/README.md b/analysis/README.md
new file mode 100644
index 0000000..c2311e5
--- /dev/null
+++ b/analysis/README.md
@@ -0,0 +1,22 @@
+# Analysis
+
+This folder contains our raw data from testing Candelabra, and the notebook we used to create visualisations used in the thesis.
+
+To run the notebook, start a [livebook](https://livebook.dev) server with `livebook server`, and open `vis.livemd` using it.
+
+## Using new data
+
+To use new data, first generate some new data locally. In `../src/`:
+
+```
+$ just cost-models # approx 10m
+$ just comparisons 2>&1 | tee ../analysis/current/log # approx 1hr 30m
+```
+
+We need to also write the log output when comparing since we use this during analysis. To put this data in the right place, in `../analysis`:
+
+```
+$ just split-log
+$ just fetch-cost-models
+$ just fetch-comparisons
+```
diff --git a/analysis/package.json b/analysis/package.json
deleted file mode 100644
index 880c06c..0000000
--- a/analysis/package.json
+++ /dev/null
@@ -1,11 +0,0 @@
-{
-  "name": "analysis",
-  "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "author": "",
-  "license": "ISC"
-}