From 0f45d8d199a4e3e3abb023ff5aec0f3081b039d4 Mon Sep 17 00:00:00 2001 From: Amrit Krishnan Date: Tue, 12 Nov 2024 13:59:14 -0500 Subject: [PATCH] Update the documentation about generating test data --- README.md | 27 ++++++++++++++++++++++----- docs/source/index.md | 27 ++++++++++++++++++++++----- 2 files changed, 44 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f7e4ecb..692dda3 100644 --- a/README.md +++ b/README.md @@ -82,18 +82,35 @@ docker compose --env-file .env.development --profile frontend -f docker-compose. ### 📥 Data setup -#### Download service data (211 API) +#### Test data -**GTA data** +If you want to test the system without real data, you can generate some dummy testing data: ```bash -python3 scripts/download_data.py --api-key $YOUR_211_API_KEY --dataset on --is-gta --data-dir +python3 scripts/generate_test_data.py ``` -**Ontario-wide data** +#### Download service data + +If you are using the 211 API or Empower's API, make sure you check with them to see if the API keys are +configured correctly for the geography of interest. + +**GTA data (211 API)** + +```bash +python3 scripts/download_211_data.py --api-key $YOUR_211_API_KEY --dataset on --is-gta --data-dir +``` + +**Ontario-wide data (211 API)** + +```bash +python3 scripts/download_211_data.py --api-key $YOUR_211_API_KEY --dataset on --data-dir +``` + +**Empower API data** ```bash -python3 scripts/download_data.py --api-key $YOUR_211_API_KEY --dataset on --data-dir +python3 scripts/download_empower_data.py --api-key $YOUR_EMPOWER_API_KEY --data-dir ``` #### Upload data and embeddings diff --git a/docs/source/index.md b/docs/source/index.md index 8655bb2..09f0df3 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -91,18 +91,35 @@ docker compose --env-file .env.development --profile frontend -f docker-compose. ### 📥 Data setup -#### Download service data (211 API) +#### Test data -**GTA data** +If you want to test the system without real data, you can generate some dummy testing data: ```bash -python3 scripts/download_data.py --api-key $YOUR_211_API_KEY --dataset on --is-gta --data-dir +python3 scripts/generate_test_data.py ``` -**Ontario-wide data** +#### Download service data + +If you are using the 211 API or Empower's API, make sure you check with them to see if the API keys are +configured correctly for the geography of interest. + +**GTA data (211 API)** + +```bash +python3 scripts/download_211_data.py --api-key $YOUR_211_API_KEY --dataset on --is-gta --data-dir +``` + +**Ontario-wide data (211 API)** + +```bash +python3 scripts/download_211_data.py --api-key $YOUR_211_API_KEY --dataset on --data-dir +``` + +**Empower API data** ```bash -python3 scripts/download_data.py --api-key $YOUR_211_API_KEY --dataset on --data-dir +python3 scripts/download_empower_data.py --api-key $YOUR_EMPOWER_API_KEY --data-dir ``` #### Upload data and embeddings