Adding a section to readme on how to use DATA_PATH env var

traveltime-dev · Aug 12, 2024 · 25a8c8d · 25a8c8d
1 parent c0a7b1d
commit 25a8c8d
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/Dockerfile b/Dockerfile
@@ -16,4 +16,3 @@ COPY --from=builder /app/k6 /bin/
 COPY /scripts /scripts/
 COPY /proto /proto/
 COPY /locations /locations/
-COPY /precomputed /precomputed/
diff --git a/README.md b/README.md
@@ -144,6 +144,21 @@ docker run
     -ti igeolise/traveltime-k6-benchmarks:latest k6 run scripts/routes.js
 ```
 
+### Using premade input locations
+
+```bash
+docker run 
+    -v ./precomputed:/precomputed
+    -e DATA_PATH='../precomputed/{file_name}.csv' 
+    -e APP_ID={APP_ID}
+    -e API_KEY={API_KEY}
+    ...other ENV (-e) vars...
+    -ti igeolise/traveltime-k6-benchmarks:latest k6 run scripts/{script_name}.js
+```
+
+- `origins.csv` is used for: time-map, time-map-fast, distance-map, time-filter, time-filter-proto.
+- `routes.csv` is used for routes.
+
 ### Running K6 Tests Locally
 
 Install [K6](https://k6.io/docs/get-started/installation/)