Allow country to be set using quickstart

Flowminder · Jan 24, 2023 · 4b4f449 · 4b4f449
1 parent ee6f243
commit 4b4f449
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [Unreleased]
 
+### Added
+
+- Quickstart script now supports arbitrary countries via `COUNTRY` env var. [#5796](https://github.com/Flowminder/FlowKit/issues/5796)
+
 ## 1.18.0
 
 ### Added

diff --git a/docker-compose-syntheticdata.yml b/docker-compose-syntheticdata.yml
@@ -14,6 +14,7 @@ services:
     image: flowminder/flowdb-synthetic-data:${CONTAINER_TAG:-latest}
     environment:
       SYNTHETIC_DATA_GENERATOR: ${SYNTHETIC_DATA_GENERATOR:?Must set SYNTHETIC_DATA_GENERATOR env var}
+      COUNTRY: ${COUNTRY:-"NPL"}
       N_SITES: ${N_SITES:?Must set N_SITES env var}
       N_CELLS: ${N_CELLS:?Must set N_CELLS env var}
       N_SUBSCRIBERS: ${N_SUBSCRIBERS:?Must set N_SUBSCRIBERS env var}
@@ -27,3 +28,4 @@ services:
       INTERACTIONS_MULTIPLIER: ${INTERACTIONS_MULTIPLIER:?Must set INTERACTIONS_MULTIPLIER env var}
       DISASTER_START: ${DISASTER_START:?Must set DISASTER_START env var}
       DISASTER_END: ${DISASTER_END:?Must set DISASTER_END env var}
+      DISASTER_REGION_PCOD: ${DISASTER_REGION_PCOD:-"NPL.1.1_1"}
diff --git a/docs/source/install.md b/docs/source/install.md
@@ -60,6 +60,12 @@ bash <(curl -s https://raw.githubusercontent.com/Flowminder/FlowKit/master/quick
 
 to get the examples with the larger dataset (the one used when producing this documentation).
 
+You can also explore FlowKit using synthetic data for other countries, by setting the `COUNTRY` environment variable to a three-level ISO country code, for example to simulate data for the UK with a crisis in Greater London:
+
+```bash
+COUNTRY=GBR DISASTER_REGION_PCOD=GBR.1.36_1 bash <(curl -s https://raw.githubusercontent.com/Flowminder/FlowKit/master/quick_start.sh) examples
+```
+
 !!! info
     The small dataset is sufficient for most of the worked examples, but the larger dataset is required for the [Flows Above Normal](analyst/worked_examples/flows-above-normal.ipynb) example because this uses data for dates outside the range included in the small dataset.