A small repo to generate a map of South Africa's streets colour coded by the name's origin.
# South Africa Street History Mapping
We were curious about visualising how street names correlate to their language or place of origin in South Africa - a
country whose history is marked by significant power struggles and complex race relations. This repo provides the code
for creating maps of street networks colour coded by place of origin and language.
This readme is divided into:
* Outputs
* Results
* Running the code
* Helpful Notebooks
* Contact
[//]: # (* [References](#references))
## Outputs
* Peer Reviewed Extended Abstract Submission for IC2S2 2024
* Poster for IC2S2 2024
* Paper coming soon!
## Results
| Area | Dictionary Lookup | Language Detector |
|--------------|-------------------------------------------------------|---------------------------------------------------------------------|
| Johannesburg | | |
| Soweto | | |
| Sandton | | |
| Cape Town | | |
## Running the code
This section describes how to run the code. Feel free to open an issue if you have any questions!
### Prerequisites
* If windows, git bash
* Docker
* Poetry
* ~5GB Disk Space (Docker images + data)
### Setup
Poetry is used to manage packages and virtual environments.
```shell
poetry shell
```
```shell
poetry install
```
### Data Download Pipeline
#### 1. Retrieve streets for relevant countries
_Core Code:_ download_country_streets.py
We first need to download all street names for South Africa and selected countries that have played a role in South
Africa's history (see countries). Data is downloaded using
the Overpass API - an API that retrieves data easily
from OpenStreetMaps.
To retrieve street data, check that you're happy with what countries are being retrieved and run:
```shell
python ./src/street_list_download/main.py
```
If you're on a slurm enabled cluster, you can run
```shell
sbatch ./scripts/1_r …