/ohsome-quality-analyst

Data quality estimations of OpenStreetMap data.

Primary LanguagePythonGNU Affero General Public License v3.0AGPL-3.0

ohsome quality analyst

build status Sonarcloud Status LICENSE Website status: active

The ohsome quality analyst (OQT) is a software developed by Heidelberg Institute for Geoinformation Technology (HeiGIT) and based on the ohsome platform. The main purpose is to compute and provide quality estimations of OpenStreetMap (OSM) data.

Blog

The following blog posts give insight into OQT:

Usage

OQT can be used in three ways with various degree of usability and flexibility:

  1. Interactive access through the website (Highest usability; Lowest flexibility)
  2. Making requests to the REST API
  3. Usage of the Command-Line-Interface (CLI) (Lowest usability; Highest flexibility)

The easiest access to quality reports is through the OQT website. There reports with pre-computed indicators can be accessed for a selection of regions made by the OQT team. But it is not possible to upload custom areas-of-interest (AOIs) and compute report or indicators for those.

Requests for individual indicators as well as reports can be made to the OQT API. Retrievable are pre-computed indicators for selected regions (Parameters dataset=regions and featureId) as well as for custom AOIs (Parameter bpolys). The major drawback is the limitation of the input geometry size. For more information check out the interactive API documentation.

The last way to use OQT is by setting up OQT on your local machine and use the provided CLI. This is the most flexible way but some technical knowledge is required to set it up. For now please refer to the development setup documentation on how to set up OQT locally on your machine. After installation of the ohsome_quality_analyst Python package run oqt --help for documentation about the CLI.

The API as well as the CLI will return a GeoJSON Feature. This GeoJSON will preserve both the geometry and property field of the input GeoJSON Feature. The data and results of the indicator or report and its associated indicators are written to the property field in a flat hierarchy of the resulting GeoJSON Feature.

Contributing

Please refer to CONTRIBUTING.md.

Looking to implement a new indicator? Then please have a look at docs/indicator_creation.md

Looking to add a new layer to run your analysis with? Then please have a look at docs/layer.md

Development Setup

Please refer to docs/development_setup.md.

Components

This diagram gives an overview of the OQT components: