# duckOSM

> OpenStreetMap to a routable road network in one DuckDB file, with edge IDs that survive every rebuild, clip and export.

duckOSM turns OpenStreetMap data into routable road networks (driving, walking, cycling) in one DuckDB file, with stable edge ids, legal turns, and exports to SUMO, MATSim, GMNS and more. An agent skill with the essentials: https://github.com/Khoshkhah/duckOSM/blob/main/skills/duckosm/SKILL.md


## Get started

- [Home](https://khoshkhah.github.io/duckOSM/index.md)
- [Install](https://khoshkhah.github.io/duckOSM/install/index.md)
- [Your first network](https://khoshkhah.github.io/duckOSM/first_network/index.md)

## Guides

- [Prepare an area](https://khoshkhah.github.io/duckOSM/guides/prepare-area/index.md)
- [Build a network](https://khoshkhah.github.io/duckOSM/guides/build/index.md)
- [Fix OSM errors](https://khoshkhah.github.io/duckOSM/guides/fix-osm-errors/index.md)
- [Query the database](https://khoshkhah.github.io/duckOSM/guides/query/index.md)
- [Draw a map](https://khoshkhah.github.io/duckOSM/guides/draw-map/index.md)
- [Store the drawing order](https://khoshkhah.github.io/duckOSM/guides/drawing-order/index.md)
- [Route](https://khoshkhah.github.io/duckOSM/guides/route/index.md)
- [Add elevation](https://khoshkhah.github.io/duckOSM/guides/elevation/index.md)
- [Add administrative boundaries](https://khoshkhah.github.io/duckOSM/guides/admin-boundaries/index.md)
- [Check a build](https://khoshkhah.github.io/duckOSM/guides/check-build/index.md)

## Exports

- [Overview](https://khoshkhah.github.io/duckOSM/exports/index.md)
- [SUMO](https://khoshkhah.github.io/duckOSM/exports/sumo/index.md)
- [MATSim](https://khoshkhah.github.io/duckOSM/exports/matsim/index.md)
- [GMNS](https://khoshkhah.github.io/duckOSM/exports/gmns/index.md)
- [GMNS tables](https://khoshkhah.github.io/duckOSM/exports/gmns_tables/index.md)
- [GeoPackage / shapefile](https://khoshkhah.github.io/duckOSM/exports/gis/index.md)
- [networkx](https://khoshkhah.github.io/duckOSM/exports/networkx/index.md)
- [OpenDRIVE](https://khoshkhah.github.io/duckOSM/exports/opendrive/index.md)
- [Lanelet2](https://khoshkhah.github.io/duckOSM/exports/lanelet2/index.md)
- [railML](https://khoshkhah.github.io/duckOSM/exports/railml/index.md)
- [Lane-level routing](https://khoshkhah.github.io/duckOSM/exports/lane-routing/index.md)

## Concepts

- [How a build works](https://khoshkhah.github.io/duckOSM/concepts/build/index.md)
- [Stable edge ids](https://khoshkhah.github.io/duckOSM/concepts/edge-ids/index.md)
- [What each network contains](https://khoshkhah.github.io/duckOSM/concepts/networks/index.md)
- [Network clean-up](https://khoshkhah.github.io/duckOSM/concepts/cleanup/index.md)
- [Routing across modes](https://khoshkhah.github.io/duckOSM/concepts/multimodal/index.md)
- [duckOSM and OSMnx](https://khoshkhah.github.io/duckOSM/concepts/osmnx/index.md)

## Reference

- [Command line](https://khoshkhah.github.io/duckOSM/reference/cli/index.md)
- [Configuration](https://khoshkhah.github.io/duckOSM/reference/configuration/index.md)
- [Database schema](https://khoshkhah.github.io/duckOSM/reference/database/index.md)
- [Base-map layers](https://khoshkhah.github.io/duckOSM/reference/features/index.md)
- [Elevation sources](https://khoshkhah.github.io/duckOSM/reference/elevation-sources/index.md)

## Development

- [Development](https://khoshkhah.github.io/duckOSM/development/index.md)