osm-flex

Python package for flexible data extraction from OpenStreetMap. This packages allows to

1. download OSM data dumps
2. [optional] clip to desired shape
3. extract specific features to geodataframes
4. [optional] simplify results based on geospatial operations

Documentation

Please refer to the ReadTheDocs of this project for the full documentation of all functions.

Installation

conda create -n osm-flex cartopy geopandas
conda activate osm-flex
pip install osm-flex

NOTE

This package requires shapely v2.0 or later. Installing this package in an existing environment might overwrite older versions.

The (optional) clipping functionalities require manual installation of osmconvert or osmosis. See tutorial 1 for details.

Example

Download osm data for Switzerland from geofabrik.

import osm_flex.download as dl

iso3 = 'CHE'
dl.get_country_geofabrik(iso3)

Extract all buildings related to education and extract all polygons with forests.

import osm_flex.extract as ex
from osm_flex.config import OSM_DATA_DIR

path_che_dump = OSM_DATA_DIR.joinpath('switzerland-latest.osm.pbf')              

gdf_ch_education = ex.extract_cis(path_che_dump, 'education')    

gdf_ch_forest = ex.extract(
	path_che_dump, 'multipolygons', ['landuse', 'name'], "landuse='forest'"
	)    

Drop all education building units that are contained within larger education buildings.

import osm_flex.simplify as sy
gdf_ch_education = sy.rremove_contained_polys(gdf_ch_education)

Running Tests

Follow installation instructions. Then,

python -m pip install -e "./[tests]"
pytest