README.md

HERE Map Widget for Jupyter

Use HERE Maps API for JavaScript in your Jupyter Notebook.

Usage

Selecting a basemap:

Loading a GeoJSON data on a map:

Making use of HERE Maps API for JavaScript primitives such as Marker to draw a SVG icon on the map:

Using the search control to search GeoJSON layer data:

Displaying GeoPandas data on map:

Displaying XYZ Hub or HERE Data Hub space data on a map:

Use ipywidgets controls to build an interactive GUI:

Selecting external basemaps:

Prerequisites

Before you can install this package, or use the example notebooks to make sure your system meets the following prerequisities:

• A Python installation, 3.6+ recommended, with the pip command available to install dependencies
• A HERE developer account, free and available under HERE Developer Portal
• An API key from the HERE Developer Portal

Installation

Install HERE Map Widget for Jupyter with conda from the Anaconda conda-forge channel using the below command:

$ conda install -c conda-forge here-map-widget-for-jupyter

Install HERE Map Widget for Jupyter from PyPI using the below command:

$ pip install here-map-widget-for-jupyter

Below extra commands are required only if you are using classic Jupyter Notebook (version 5.3 or older):

$ jupyter nbextension install --py --sys-prefix here_map_widget

$ jupyter nbextension enable here_map_widget --py --sys-prefix

Below extra commands are required only if you are using JupyterLab (version 2 or older):

$ npm config set @here:registry https://repo.platform.here.com/artifactory/api/npm/here-node/

$ jupyter labextension install @jupyter-widgets/jupyterlab-manager @here/map-widget-for-jupyter

Installation from source repository on GitHub

For a development installation (requires yarn, you can install it with conda install -c conda-forge yarn):

$ npm config set @here:registry https://repo.platform.here.com/artifactory/api/npm/here-node/
$ git clone https://github.com/heremaps/here-map-widget-for-jupyter.git
$ cd here-map-widget-for-jupyter
$ pip install -e .

If you are using the classic Jupyter Notebook you need to install the nbextension:

$ jupyter nbextension install --py --sys-prefix here_map_widget

$ jupyter nbextension enable here_map_widget --py --sys-prefix

Note for developers:

• the -e pip option allows one to modify the Python code in-place. Restart the kernel in order to see the changes.
• the --symlink argument on Linux or OS X allows one to modify the JavaScript code in-place. This feature is not available with Windows.

For developing with JupyterLab:

$ jupyter labextension develop --overwrite here_map_widget

Documentation

Documentation is available here

Related projects

Below projects use here-map-widget-for-jupyter as plotting backend

• leafmap
• HERE Inspector package of HERE Data SDK for Python v2

License

Copyright (C) 2019-2021 HERE Europe B.V.

Unless otherwise noted in LICENSE files for specific directories, the LICENSE in the root applies to all content in this repository.