Skip to content

mapaction/proximity-tool

Repository files navigation

Proximity Tool

Open in Streamlit license Code style: black Imports: isort

[Tool under development]

This repository contains a Streamlit app that allows users to calculate isochrones given a set of points of interest. Moreover, population figures for each isochrone (aggregated and disaggregated by age and gender) are retrieved from WorldPop.

The tool uses the Openrouteservice API, maintained by the Heidelberg Institute for Geoinformation Technology (HeiGIT).

Usage

Requirements

The Python version currently used is 3.9. Please install all packages from requirements.txt:

pip install -r requirements.txt

Run the app

This tool uses the openrouteservice public API. Before running the app, create a file called .env in the main folder and add the line

API_KEY = <your_api_key>

Replace <your_api_key> with your API key in quotes. To obtain one, create an account on their website.

Finally, open a terminal and run

streamlit run app/Home.py

A new browser window will open and you can start using the tool.

Contributing

Pre-commit

All code is formatted according to black and flake8 guidelines. The repo is set-up to use pre-commit. Please run pre-commit install the first time you are editing. Thereafter all commits will be checked against black and flake8 guidelines.

To check if your changes pass pre-commit without committing, run:

pre-commit run --all-files

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published