README.md 1.97 KB
Newer Older
Moritz Schott's avatar
Moritz Schott committed
1
2
# OSHDB Examples

3
4
5
6
7
[![Build Status](http://jenkins.ohsome.org/buildStatus/icon?job=oshdb-examples/oshdb-snapshot)](http://jenkins.ohsome.org/blue/organizations/jenkins/oshdb-examples/activity)
[![Sonarcloud Status](https://sonarcloud.io/api/project_badges/measure?project=org.heigit.ohsome:oshdb-examples&metric=alert_status)](https://sonarcloud.io/dashboard?id=org.heigit.ohsome:oshdb-examples)
[![LICENSE](https://img.shields.io/badge/license-Apache--2.0-orange)](LICENSE)
[![status: active](https://github.com/GIScience/badges/raw/master/status/active.svg)](https://github.com/GIScience/badges#active)

Johannes Visintini's avatar
Johannes Visintini committed
8
These are some examples for the use of the OSHDB. This repository focuses on the [OSHDB-API](https://github.com/GIScience/oshdb/blob/master/documentation/first-steps/README.md).
Moritz Schott's avatar
Moritz Schott committed
9

10
You can check out this repository and run the example classes – to see immediate results or use it as building blocks for coding your own OSHDB queries.
Moritz Schott's avatar
Moritz Schott committed
11

12

Johannes Visintini's avatar
Johannes Visintini committed
13
## Main Branches
14

Johannes Visintini's avatar
Johannes Visintini committed
15
16
| branch name | description |
| ----------- | ----------- |
17
18
19
20
| [`oshdb-snapshot`](https://gitlab.gistools.geog.uni-heidelberg.de/giscience/big-data/ohsome/oshdb-examples/-/tree/oshdb-snapshot) (default) | use if you want to work with the [current development state](https://github.com/giscience/oshdb/tree/master) of the OSHDB |
| [`oshdb-stable`](https://gitlab.gistools.geog.uni-heidelberg.de/giscience/big-data/ohsome/oshdb-examples/-/tree/oshdb-stable) | use if you want to work with the [latest release](https://github.com/GIScience/oshdb/releases/latest) of the OSHDB |

## Tutorial
Moritz Schott's avatar
Moritz Schott committed
21

22
The [tutorial](https://gitlab.gistools.geog.uni-heidelberg.de/giscience/big-data/ohsome/oshdb-examples/tree/master/src/main/java/org/heigit/ohsome/oshdb/tutorial) is a quick and simple dive into the OSHDB-API-Code.
Moritz Schott's avatar
Moritz Schott committed
23

24
## Analyses
Moritz Schott's avatar
Moritz Schott committed
25

26
Some example analyses used in research are demonstrated in the [analyses](https://gitlab.gistools.geog.uni-heidelberg.de/giscience/big-data/ohsome/oshdb-examples/tree/master/src/main/java/org/heigit/ohsome/oshdb/examples/analyses) package.