Configuration

envirodata is a python package, and provided for use as Docker container. It is configured through one configuration file, config.yaml.

It relies on two external pieces of software which are also provided as Docker containers:

• Nominatim: geocoder based on OpenStreetMap data
• BrightSky: data extraction from the German Weather Service (DWD)

Installation

1. Install docker, e.g. follow these instructions for Ubuntu. On Linux, all docker will need to be sudo'ed unless you are root.

2. Clone envirodata repo (need username or deploy token - contact us):

git clone https://git.rz.uni-augsburg.de/mmbees-git/envirodata.git

1. Setup and start Docker containers (as daemons in background):

cd envirodata docker compose up -d

1. To load new data and update the existing data:

docker exec envirodata poetry run load_data config.yaml

This might well take several hours for the first run.

The Envirodata service is now running in background. You can access the user interface in your browser at

localhost:8000

Documentation

Sphinx API documentation can be created using tools/build_docs.bash, and then be found at docs/_build/index.html.