Skip to content

Commit

Permalink
add readme links
Browse files Browse the repository at this point in the history
  • Loading branch information
Hussein-Mahfouz committed Nov 12, 2024
1 parent ec19f67 commit 8a5281b
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -142,6 +142,8 @@ bash ./scripts/run_pipeline.sh config/<your_config_file>.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:
Expand Down

0 comments on commit 8a5281b

Please sign in to comment.