https://github.com/giscience/osm-transform
Custom data filtering and enrichment for OpenStreetMap PBF files for a better openrouteservice graph building
https://github.com/giscience/osm-transform
cleanup data elevation enrichment filter graphs openrouteservice openstreetmap pbf routing
Last synced: about 2 months ago
JSON representation
Custom data filtering and enrichment for OpenStreetMap PBF files for a better openrouteservice graph building
- Host: GitHub
- URL: https://github.com/giscience/osm-transform
- Owner: GIScience
- Created: 2023-05-02T11:11:10.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-10T11:22:37.000Z (12 months ago)
- Last Synced: 2024-07-10T13:27:50.013Z (12 months ago)
- Topics: cleanup, data, elevation, enrichment, filter, graphs, openrouteservice, openstreetmap, pbf, routing
- Language: C++
- Homepage:
- Size: 3.39 MB
- Stars: 3
- Watchers: 12
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# osm-transform
A command line tool to preprocess OpenStreetMap data for routing purposes.
The tool reads an OpenStreetMap pbf file, filters data that is not relevant for routing (e.g. buildings) and produces a much smaller pbf file.
At the same time, the tool enriches the data with information about the country the data is in and optionally with elevation data.
The output pbf file can be used e.g. for openrouteservice graph building.
## Run tests
Run all tests:
```shell
cargo test
```
Integration tests:
```shell
cargo test --test integration_test
```
## Run locally
```shell
cargo clean
cargo run --
```
To get help about the command line options, run:
```shell
cargo run -- -h
```
## Build locally
```shell
cargo clean
cargo build
```
Or a optimized, faster version (build is slower):
```shell
cargo clean
cargo build --release
```
The executable binaries created by `cargo build` or `cargo build --release` are located in the `target/debug` or `target/release` directory respectively.
You can run the executable with the same options as described above for running locally:
```shell
./target/debug/osm-transform
./target/release/osm-transform
```
## Docker
### Build docker image
Run docker build and tag the image with e.g. `local/osm-transform:latest`:
```shell
docker rmi local/osm-transform:latest # if you have an old image
docker build -t local/osm-transform:latest .
```
If you don't want to build a docker image yourself, you can use the prebuilt image from docker hub: ```heigit/osm-transform:latest```.
In the other examples in this README, add replace `local/osm-transform:latest` with `heigit/osm-transform:latest`.
### Run docker image
When running the docker image, you can add all command line options for the rust application behind the docker image name.
E.g. you can get help by running the following command:
```shell
docker run --rm local/osm-transform:latest -h
```
In all other use cases than getting help, you want to process an input file and potentially enrich the data with
information from other files. Therefore you need to mount the directories containing the input files to the docker.
The following command mounts the directories `~/data/osm`, `~/data/countries` and `~/data/elevation` to the docker
directories `/app/osm`, `/app/countries` and `/app/elevation` respectively.
You can mount whichever directories you want, but you need to adjust the paths in the command according to the
paths in the container:
```shell
docker run --rm \
-v ~/data/osm:/app/osm \
-v ~/data/countries:/app/countries \
-v ~/data/elevation:/app/elevation \
-v .:/app/out \
local/osm-transform:latest \
-i /app/osm/heidelberg.test.pbf \
-o /app/out/heidelberg.ot.pbf \
-c /app/countries/world_borders_idx_0_40 \
-e '/app/elevation/*/*.tif' \
-vvv
```
## Roadmap
* performance and memory usage improvements
* enable custom filter options
* support for more custom enrichment source files, e.g.:
* other csv area with other information than countries, e.g. time zones
* other geotiff files for raster based enrichment
* make it possible to only build area indexes without processing a pbf file