Integrating OpenStreetMap with ArcGIS

The heart of this notebook is a simple ORM named OSM Runner that integrates OpenStreetMap data into the Esri platform using the power of SpatialDataFrames. Using the functionality from Jupyter Dashboard, we can build a notebook that allows users to interactively find data from OpenStreetMap and migrate that information into their ArcGIS organization.

This notebook does not rely on ArcPy being called implicitly in the background. To run this notebook you can do the following:

* Create a new environment with Conda
    * conda create -n osm_dash python=3.6 -y

* Activate new environment
    * activate osm_dash

* Install ArcGIS API for Python
    * conda install arcgis -c esri -y

* Install Jupyter Dashboard
    * conda install jupyter_dashboards -c conda-forge -y

* Install requests, pyproj, pyshp
    * conda install requests pyproj pyshp -y

* Install osm_runner
    * pip install osm-runner

* Run 'jupyter notebook' with environment activated and navigate to this notebook on your system

* Set the org_url, username, and password for the GIS variable in the first cell of this notebook
In [1]:
# Libraries for Creating Buttons & Handling Output
from IPython.display import display, clear_output
import ipywidgets as widgets

# OSM Runner & GIS Object
    from osm_runner import gen_osm_sdf
    !pip install osm_runner
    from osm_runner import gen_osm_sdf
from arcgis.gis import GIS

# Transformations & Geometries for ArcGIS Item Creation
    from pyproj import Proj, transform
    import shapefile
    !conda install pyproj --yes
    from pyproj import Proj, transform
    import shapefile

# Other Libraries
from collections import OrderedDict
import time

# Organization Login
gis = GIS('', 'username', 'password')

The following cell is used to map accepted values in the OSM Runner configuration to more user-friendly values; e.g. man_made -> Made Made.

In [2]:
# Set OSM Tags with Friendly Names
osm_tag_dict = {
    "Aerialway":        "aerialway",
    "Aeroway":          "aeroway",
    "Amenity":          "amenity",
    "Barrier":          "barrier",
    "Boundary":         "boundary",
    "Building":         "building",
    "Craft":            "craft",
    "Emergency":        "emergency",
    "Geological":       "geological",
    "Highway":          "highway",
    "Historic":         "historic",
    "Landuse":          "landuse",
    "Leisure":          "leisure",
    "Man Made":         "man_made",
    "Military":         "military",
    "Natural":          "natural",
    "Office":           "office",
    "Place":            "place",
    "Power":            "power",
    "Public Transport": "public transport",
    "Railway":          "railway",
    "Route":            "route",
    "Shop":             "shop",
    "Sport":            "sport",
    "Tourism":          "tourism",
    "Waterway":         "waterway"

The follwing cell takes the extent of the Map, ensures the coordinates are in decimal degrees, and returns a bounding box.

In [3]:
# Converting Map Widget Extent into a Tuple for OSM Query
def collect_extent(e):
    # Strip Min/Max For Geometry Iterable
    min_set = {k[:1]: v for k, v in e.items() if k in ['ymin', 'xmin']}
    max_set = {k[:1]: v for k, v in e.items() if k in ['ymax', 'xmax']}

    box = []
    for geo_set in [min_set, max_set]:
        incoming_wkid = e.get('spatialReference')['latestWkid']
        if incoming_wkid == 4326:
            p1 = Proj(init='epsg:{}'.format(incoming_wkid))
            p2 = Proj(proj='latlong',datum='WGS84')
            x, y = transform(p1, p2, geo_set['x'], geo_set['y'])

    return tuple(box)

The following cell takes the form input, uses OSM Runner to collect a SpatialDataFrame containing OpenStreetMap data, and then creates a simple popup for display in the Map.

In [4]:
# on_click() Logic
def running(button_object):

    global sdf
    # Pull Values From Inputs
    geo_val = geo_sel.value
    osm_val = osm_sel.value
    bbox    = collect_extent(viz_map.extent)
    # Get Date YYYY-MM-DD From DatePicker
    t_1_val = str(t_1_sel.value)[:10] if t_1_sel.value else None
    t_2_val = str(t_2_sel.value)[:10] if t_2_sel.value else None
        print('Fetching Data From OpenStreetMap . . .')
        sdf = gen_osm_sdf(geo_val, bbox, osm_val, t_1_val, t_2_val)
    except Exception as e:
        print('Request Could Not Be Completed')
        print('Features Returned: {}'.format(len(sdf)))
        sdf_fs = sdf.to_featureset()
        for feature in sdf_fs:
            # Create Popup
                    'title': 'OSM ID: ' + feature.attributes['osm_id'] , 
                    'content': "{}".format(
                            '%s: %s' % (key.upper(), value) for (key, value) in feature.attributes.items()

The next two cells are handling visual aspects of the dashboard title and the Map.

In [5]:
.intro {
    padding: 10px; 
    color: #202020;
    font-family: 'Helvetica'
.map {
    border: solid;
    height: 450px;

OpenStreetMap Runner

Use the map below to limit the extent of your OSM query. Please consult the OSM Wiki for more information on what data can be found under the various Feautres provided in the dropdown. Enter a name for the new Hosted Feature Layer that will be created in your ArcGIS Online organization.

The following cell sets the default location for the Map, creates the form inputs from the ipywidgets library, assigns logic to the submit button, and then adds everything to the display.

In [6]:
# Create & Display Map
viz_map ='Smithsonian')

# Set Options For Return Geometry
geo_sel = widgets.Dropdown(
    options=['Point', 'Line', 'Polygon'],

# Set Options for OSM Tags
osm_sel = widgets.Dropdown(
    options=(sorted(osm_tag_dict.items(), key=lambda item: item[0])),

# Set Options for Time Selection
t_1_sel = widgets.DatePicker(description='Start Date')
t_2_sel = widgets.DatePicker(description='End Date')

# Create Submit Button & Set on_click
run_btn = widgets.Button(
    description='Fetch OSM',
    tooltip='Query OSM and View in Map Widget',
    layout=widgets.Layout(justify_content='center', margin='0px 0px 0px 10px')

# Handle Widget Layout
params = widgets.HBox(
    [geo_sel, osm_sel, t_1_sel, t_2_sel, run_btn], 
    layout=widgets.Layout(justify_content='center', margin='10px')

The following cell handles the logic for pushing the SpatialDataFrame returned from OSM Runner into ArcGIS Online and displaying the results in the dashboard.

In [7]:
def to_agol(button_object):
    txt_val = txt_sel.value
    except NameError:
        print('Please Collect Data with Fetch OSM Data First . . .')
        print('Creating Feature Layer in ArcGIS Online . . .')
        feat_lyr = sdf.to_featurelayer(
            '{}_{}'.format(txt_val, int(time.time())),
            tags='OSM Runner'


The following cell adds another form so that the user can set a name for the results of OSM Runner and then push that information to their ArcGIS organization.

In [8]:
txt_sel = widgets.Text(description='Name', value='OSM Features')

add_btn = widgets.Button(
    description='Push OSM to ArcGIS',
    tooltip='Create Content in ArcGIS Online'

add_box = widgets.HBox([txt_sel, add_btn], layout=widgets.Layout(justify_content='center', margin='10px'))

Feedback on this topic?