From 8a5281b318c28b9b4bdbec156db8251159eb0a0a Mon Sep 17 00:00:00 2001 From: Hussein Mahfouz <45176416+Hussein-Mahfouz@users.noreply.github.com> Date: Tue, 12 Nov 2024 17:47:27 +0100 Subject: [PATCH] add readme links --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3f12085..ab00af7 100644 --- a/README.md +++ b/README.md @@ -124,11 +124,11 @@ The pipeline is a series of scripts that are run in sequence to generate the act ## Step 1: Prepare Data Inputs -You need to populate the data/external diectory with the required datasets. A guide on where to find / generate each dataset can be found in the [data/external/README.md] +You need to populate the data/external diectory with the required datasets. A guide on where to find / generate each dataset can be found in the [data/external/README.md](https://github.com/Urban-Analytics-Technology-Platform/acbm/tree/main/data/external) ## Step 2: Setup your config.toml file -You need to create a config file in the config directory. The config file is a toml file that contains the parameters for the pipeline. A guide on how to set up the config file can be found in the [config/README.md] +You need to create a config file in the config directory. The config file is a toml file that contains the parameters for the pipeline. A guide on how to set up the config file can be found in the [config/README.md](https://github.com/Urban-Analytics-Technology-Platform/acbm/tree/main/config) ## Step 3: Run the pipeline @@ -142,6 +142,8 @@ bash ./scripts/run_pipeline.sh config/.toml where your config file is the file you created in Step 2. +For details on what each script does, you can check the [scrips/README.md](https://github.com/Urban-Analytics-Technology-Platform/acbm/tree/main/scripts) and the [WIKI](https://github.com/Urban-Analytics-Technology-Platform/acbm/wiki) + ## Future Work We aim to include different options for each step of the pipeline. Some hopes for the future include: