osm_extract
Download OpenStreetMap road network data for a geographic area using bbox, city+radius, OD data file, or zone shapefile. Outputs .osm file for traffic simulation.
Instructions
[Step 1/5] Extract OpenStreetMap (OSM) road network data for a given area.
This is the FIRST step in the simulation pipeline. It downloads or extracts
raw OSM data (.osm file) for the specified geographic area.
Next step: Use net_convert() to convert the .osm file to SUMO .net.xml format.
=== AREA SPECIFICATION (priority order) ===
1. bbox: Direct coordinates [west, south, east, north]
Example: [127.015, 37.490, 127.040, 37.506]
2. od_data_file: Auto-compute bbox from OD CSV coordinate columns
(use column_mapping if columns are not named O_lon, O_lat, D_lon, D_lat)
3. zone_shp_file: Auto-compute bbox from shapefile geometry bounds
4. city + radius: Geocode city name and use radius in KILOMETERS (not meters!)
Example: city="Gangnam Station", radius=1.5
=== PARAMETERS ===
- city_en (REQUIRED): English name for file naming. Example: "gangnam", "manhattan_midtown"
- bbox: [west, south, east, north] bounding box coordinates
- city: City/location name for geocoding (e.g., "강남역", "Times Square")
- radius: Radius in km (used with city parameter)
- od_data_file: Path to OD CSV file (bbox auto-computed from coordinate ranges)
- zone_shp_file: Path to zone shapefile (bbox auto-computed from geometry)
- column_mapping: Column name mapping for non-standard OD CSV files.
Keys are standard names, values are actual column names in the CSV.
Example: {"O_lon": "pickup_lng", "O_lat": "pickup_lat", "D_lon": "dropoff_lng", "D_lat": "dropoff_lat"}
=== PIPELINE CONTEXT ===
RandomOD: osm_extract(bbox/city+radius) → net_convert → trip_generate → route_generate → sumo_runner
RealOD-coord: osm_extract(od_data_file, column_mapping) → net_convert → trip_generate → route_generate → sumo_runner
RealOD-zone: osm_extract(zone_shp_file) → net_convert → trip_generate → route_generate → sumo_runner
=== RETURNS ===
- osm_file: Path to extracted .osm file (pass to net_convert)
- bbox: Computed bounding box (pass to net_convert for boundary trimming)
- tag: File naming tag derived from city_en
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bbox | No | ||
| city | No | ||
| radius | No | ||
| city_en | Yes | ||
| output_dir | No | output/networks | |
| od_data_file | No | ||
| zone_shp_file | No | ||
| column_mapping | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |