oshdb

OpenStreetMap History Data Analysis Framework

https://github.com/giscience/oshdb

Science Score: 85.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 11 DOI reference(s) in README
  • Academic publication links
    Links to: researchgate.net, zenodo.org
  • Committers with academic emails
    13 of 23 committers (56.5%) from academic institutions
  • Institutional organization owner
    Organization giscience has institutional domain (www.geog.uni-heidelberg.de)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.4%) to scientific vocabulary

Keywords

heigit ohsome openstreetmap openstreetmap-data openstreetmap-history openstreetmap-history-data oshdb osm osm-data osm-history-data spatio-temporal-analysis

Keywords from Contributors

distributed mesh interpretability sequences generic projection interactive optim hacking network-simulation
Last synced: 4 months ago · JSON representation ·

Repository

OpenStreetMap History Data Analysis Framework

Basic Info
  • Host: GitHub
  • Owner: GIScience
  • License: lgpl-3.0
  • Language: Java
  • Default Branch: main
  • Homepage: https://ohsome.org
  • Size: 119 MB
Statistics
  • Stars: 114
  • Watchers: 11
  • Forks: 18
  • Open Issues: 35
  • Releases: 24
Topics
heigit ohsome openstreetmap openstreetmap-data openstreetmap-history openstreetmap-history-data oshdb osm osm-data osm-history-data spatio-temporal-analysis
Created over 7 years ago · Last pushed 10 months ago
Metadata Files
Readme Changelog Contributing License Citation

README.md

OSHDB - OpenStreetMap History Data Analysis

High-performance spatio-temporal data analysis platform for OpenStreetMap full-history data. Developed by HeiGIT.

HeiGIT Logo

Build Status Sonarcloud Status Maven Central DOI javadoc status: active LICENSE

The OSHDB allows to investigate the evolution of the amount of data and the contributions to the OpenStreetMap project. It combines easy access to the historical OSM data with high querying performance. Use cases of the OSHDB include data quality analysis, computing of aggregated data statistics and OSM data extraction.

```java OSHDBDatabase oshdb = //;

Integer numberOfUsersEditingHighways = OSMContributionView.on(oshdb)
    .timestamps("2007-10-07", "2009-04-09")
    .filter("type:way and highway=*")
    .map(contribution -> contribution.getContributorUserId())
    .countUniq();

System.out.println(numberOfUsersEditingHighways);

```

The main functionality of the OSHDB is explained in the first steps tutorial.

OpenStreetMap History Data

OpenStreetMap contains a large variety of geographic data, differing widely in scale and feature type. OSM contains everything from single points of interests to whole country borders, from concrete things like buildings up to more abstract concepts such as turn restrictions. OSM also offers metadata about the history and the modifications that are made to the data, which can be analyzed in a multitude of ways.

Because of it's size and variety, possibilities of working with OSM history data are limited and there exists a lack of an easy-to-use analysis software. A goal of the OSHDB is to make OSM data more accessible to researchers, data journalists, community members and other interested people.

Central Concepts

The OSHDB is designed to be appropriate for a large spectrum of potential use cases and is therefore built around the following central ideas and design goals:

  • Lossless Information: The full OSM history data set should be stored and be queryable by the OSHDB, including erroneous or partially incomplete data.
  • Simple, Generic API: Writing queries with the OSHDB should be simple and intuitive, while at the same time flexible and generic to allow a wide variety of analysis queries.
  • High Performance: The OSM history data set is large and thus requires efficiency in the way the data is stored and in the way it can be accessed and processed.
  • Local and Distributed Deployment: Analysis queries should scale well from data explorations of small regions up to global studies of the complete OSM data set.

The OSHDB splits data storage and computations. It is then possible to use the MapReduce programming model to analyse the data in parallel and optionally also on distributed databases. A central idea behind this concept is to bring the code to the data.

Data Model

The OSHDB uses its own binary data format that encapsulates the OSM history data available from planet.osm.org and is optimized for efficient storage and access to the history data. In order to allow parallelized data processing, the OSHDB data model also includes a data partitioning scheme.

schematic overview of the OSHDB data model

See the data model section of the documentation for further information about the OSHDB data model.

API

The OSHDB offers a flexible, simple and intuitive application programming interface that provides helpful abstractions on top of the offered OSM data entities. It provides different views on the OSM history data that allow to either investigate the OSM data at specific points in time (as snapshots), or to investigate all contributions to the OSM data in their entirety. The OSHDB API also allows to filter the OSM data by arbitrary regions, time ranges and OSM properties such as tags, entity type, etc.

The API is based on the MapReduce programming model and offers powerful methods to aggregate and analyze the OSM history data. The OSHDB API is described in detail in the api section of the documentation.

Installation

The OSHDB is available as a pre-compiled maven library and can be incorporated easily in any maven project. If you're starting a new project, take a look at how your IDE handles maven projects (for example, here you find instructions how to create a new maven project using IntelliJ). Our first steps tutorial includes further information about how to add the OSHDB as a maven dependency to your projects.

Documentation

Examples

A few usage examples can be found in our oshdb-examples repository.

How to Cite

When using the OSHDB directly or indirectly (e.g. through the ohsome API) for a publication, please cite it using the doi:10.5281/zenodo.4146990 or a corresponding version-specific DOI found on zenodo.

For scientific papers or similar publications around the analysis of OSM history data, please consider to additionally also cite the technical paper describing the OSHDB: doi:10.1186/s40965-019-0061-3.

Publications and Presentations

See Also

Projects using the OSHDB:

  • https://api.ohsome.org
    A web api for executing common queries on OSM history data
  • https://osm-measure.geog.uni-heidelberg.de/about
    A research project about data quality measures related to OSM data.

Other projects analyzing OSM history data:

  • https://github.com/MaZderMind/osm-history-renderer
  • https://github.com/zehpunktbarron/iOSMAnalyzer
  • https://github.com/mojodna/osm2orc
  • https://github.com/mapbox/osm-wayback, https://mapbox.github.io/osm-analysis-dashboard/
  • https://osmstats.stevecoast.com

Owner

  • Name: GIScience Research Group and HeiGIT
  • Login: GIScience
  • Kind: organization
  • Location: Heidelberg, Germany

🌍 HeiGIT and GIScience at Heidelberg University are engaged in research and opensource development at the interface between geography and computational science

Citation (CITATION.cff)

cff-version: 1.2.3
message: "If you use this software, please cite it as below."
authors:
- family-names: "Raifer"
  given-names: "Martin"
  orcid: "https://orcid.org/0000-0002-2106-8560"
- family-names: "Troilo"
  given-names: "Rafael"
- family-names: "Mocnik"
  given-names: "Franz-Benjamin"
  orcid: "https://orcid.org/0000-0002-1759-6336"
- family-names: "Schott"
  given-names: "Moritz"
title: "OSHDB - OpenStreetMap History Data Analysis"
version: 1.2.3
doi: 10.5281/zenodo.4146990
date-released: 2021-07-22
url: "https://github.com/GIScience/oshdb"

GitHub Events

Total
  • Watch event: 4
  • Push event: 2
  • Pull request event: 3
  • Create event: 3
Last Year
  • Watch event: 4
  • Push event: 2
  • Pull request event: 3
  • Create event: 3

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 2,345
  • Total Committers: 23
  • Avg Commits per committer: 101.957
  • Development Distribution Score (DDS): 0.458
Past Year
  • Commits: 3
  • Committers: 1
  • Avg Commits per committer: 3.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Martin Raifer m****r@u****e 1,272
Rafael Troilo r****o@u****e 323
Katharina Przybill o****7@s****e 242
Moritz m****t@s****e 189
Johannes Visintini j****i@h****g 138
Sascha Fendrich s****h@u****e 37
Michael Auer m****r@g****e 27
SlowMo24 u****e@n****e 24
Matthias Merdes m****s@h****g 24
Franz-Benjamin Mocnik m****k@u****e 22
lloos l****s@u****e 18
kowatsch f****h@u****e 7
Franz-Benjamin Mocnik m****l@f****t 4
Katharina Przybill p****l@s****e 4
lloos l****s@u****e 2
Przybill o****7@s****d 2
Constantin Nicolai c****i@h****g 2
dependabot[bot] 4****] 2
sabrinaaa m****x@u****e 2
Michael Auer k****9@u****e 1
lloos l****s@n****7 1
beikerta 4****a 1
kathap 3****p 1

Dependencies

oshdb/pom.xml maven
  • com.google.guava:guava ${guava.version}
  • org.slf4j:slf4j-api
  • com.h2database:h2 ${h2.version} test
  • org.slf4j:slf4j-log4j12 test
oshdb-api/pom.xml maven
  • com.google.guava:guava ${guava.version}
  • com.h2database:h2 ${h2.version}
  • com.tdunning:t-digest 3.2
  • org.heigit.ohsome:oshdb 1.0.0-SNAPSHOT
  • org.heigit.ohsome:oshdb-filter 1.0.0-SNAPSHOT
  • org.heigit.ohsome:oshdb-util 1.0.0-SNAPSHOT
  • org.jetbrains:annotations ${jetbrainsannotations.version}
  • org.postgresql:postgresql ${postgresql.version}
  • org.slf4j:slf4j-api
  • org.slf4j:slf4j-simple ${slf4j.version}
  • org.slf4j:slf4j-log4j12 test
oshdb-api-ignite/pom.xml maven
  • ${project.groupId}:oshdb-api ${project.version}
  • org.apache.ignite:ignite-core ${ignite.version}
  • org.apache.ignite:ignite-slf4j ${ignite.version}
  • org.apache.ignite:ignite-spring ${ignite.version}
  • ${project.groupId}:oshdb-api ${project.version} test
oshdb-filter/pom.xml maven
  • org.heigit.ohsome:oshdb 1.0.0-SNAPSHOT
  • org.heigit.ohsome:oshdb-util 1.0.0-SNAPSHOT
  • org.jetbrains:annotations ${jetbrainsannotations.version}
  • org.jparsec:jparsec 3.1
  • com.h2database:h2 ${h2.version} test
  • org.slf4j:slf4j-log4j12 test
oshdb-oshpbf-parser/pom.xml maven
  • io.reactivex.rxjava2:rxjava ${rxjava2.version}
  • org.heigit.ohsome:oshdb 1.0.0-SNAPSHOT
  • org.openstreetmap.pbf:osmpbf 1.5.0
oshdb-util/pom.xml maven
  • com.googlecode.json-simple:json-simple 1.1.1
  • org.heigit.ohsome:oshdb 1.0.0-SNAPSHOT
  • org.locationtech.jts:jts-core ${jts.version}
  • com.h2database:h2 ${h2.version} test
  • org.slf4j:slf4j-log4j12 test
pom.xml maven
  • org.junit:junit-bom 5.8.2 import
  • org.slf4j:slf4j-api 1.7.36
  • org.junit.jupiter:junit-jupiter test
  • org.slf4j:slf4j-log4j12 1.7.36 test
oshdb-helpers/oshdb-application-template/pom.xml maven
  • info.picocli:picocli 4.6.3
  • org.heigit.ohsome:oshdb-database-driver 1.1.0-SNAPSHOT
oshdb-helpers/oshdb-database-driver/pom.xml maven
  • org.heigit.ohsome:oshdb-api-ignite 1.1.0-SNAPSHOT compile
  • com.zaxxer:HikariCP 5.0.1
oshdb-tool/pom.xml maven
  • org.heigit.ohsome:oshdb-api-ignite 1.1.0-SNAPSHOT
.github/workflows/rocketchat-notifications-feedback-requests.yml actions
oshdb-helpers/pom.xml maven