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

Johannes Visintini's avatar
Johannes Visintini committed
3
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
4

5
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
6

7

Johannes Visintini's avatar
Johannes Visintini committed
8
## Main Branches
9

Johannes Visintini's avatar
Johannes Visintini committed
10
11
| branch name | description |
| ----------- | ----------- |
12
13
14
15
| [`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
16

17
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
18

19
## Analyses
Moritz Schott's avatar
Moritz Schott committed
20

21
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.