gde-core

Creates the Global Dynamic Exposure (GDE) model.

Description

gde-core creates the Global Dynamic Exposure (GDE) model by bringing together:

• aggregated exposure models distributed on zoom level 18 tiles (output of gde-importer),
• OpenBuildingMap (OBM) buildings (output of rabotnik-obm),
• automatically-calculated completeness of OpenBuildingMap (OBM) (output of obmgapanalysis).

Installing gde-core

Software dependencies

• Python 3.7, 3.8 or 3.9

Python libraries

• numpy
• shapely
• geopandas
• gde-importer

Install

git clone https://git.gfz-potsdam.de/dynamicexposure/globaldynamicexposure/gde-core.git
cd gde-core
pip3 install -e .

Preparation

Run the previous steps

gde-core requires that the following software be run in advance for the geographic area and input aggregated exposure models of interest:

1. rabotnik-obm: processing of OpenStreetMap (OSM) data to generate the OpenBuildingMap (OBM).
2. obmgapanalysis: estimation of completeness of OpenBuildingMap by means of an automatic comparison between remote-sensing-derived built-up area (from the Global Human Settlement Layer) and OBM-derived built-up area.
3. gde-importer: import of aggregated exposure models and their distribution on zoom level 18 tiles.

This requisite implies as well that the database tables that are output of these software exist and are populated with relevant data. The databases associated with these software are:

• GDE Tiles
• OBM Tiles
• OBM Buildings

Configuration

Copy the file config_example.yml to your working directory as config.yml and provide the necessary parameters. Required parameters are:

• model_name: Name of the input aggregated exposure model to be processed. It needs to have been imported by gde-importer already.
• exposure_entities_to_run: List of names of exposure entities for which the code will be run. Currently supported options:
  • "all": The list of names associated with model_name will be retrieved from the GDE Tiles database.
  • A comma-space-separated list of entity names: This list of names will be used.
  • A full path to a .txt or .csv file: The list of names will be retrieved from the indicated .txt/.csv file.
• exposure_entities_code: Either "ISO3" or a nested structure with exposure entities names and 3-character codes. When running model_name=esrm20, "ISO3" is the preferred option.
• occupancies_to_run: List of occupancies for which the code will be run, separated by ", " (comma and space). They need to exist for the indicated exposure format. Currently supported values: residential, commercial, industrial.
• database_gde_tiles: Credentials for the GDE Tiles database where information on the GDE tiles is stored.
• database_obm_buildings: Credentials for the OBM Buildings database where information on the OBM buildings is stored.

Running gde-core

From the working directory (where you placed config.yml), run the code by typing:

gdecore

Copyright and copyleft

Copyright (C) 2022

• Helmholtz-Zentrum Potsdam Deutsches GeoForschungsZentrum GFZ

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Also add information on how to contact you by electronic and paper mail.

If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a "Source" link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements.

See the LICENSE for the full license text.