Skip to main content

A widget that enables you to use HERE Maps API for JavaScript in Jupyter Notebook.

Project description

HERE Map Widget for Jupyter

Use HERE Maps API for JavaScript in your Jupyter Notebook.

Usage

Selecting a basemap:

Select base map

Loading a GeoJSON data on a map:

Use GeoJSON on map

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

Add marker to map

Using the search control to search GeoJSON layer data:

Add search control to map

Displaying GeoPandas data on map:

Add Geopandas data to map

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

Add XYZ data to map

Use ipywidgets controls to build an interactive GUI:

Add ipywidgets controls

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 Node.js installation, 10.13.0+ recommended, with the npm 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

In order to be able to use the HERE Maps API for JavaScript with npm the HERE public repository must be added to your npm configuration:

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

Install HERE Map Widget for Jupyter Notebook using the commands below:

$ pip install here-map-widget-for-jupyter
$ jupyter nbextension install --py --sys-prefix here_map_widget
$ jupyter nbextension enable here_map_widget --py --sys-prefix

Install HERE Map Widget for JupyterLab (version 2 or older):

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

For a development installation (requires npm to be pre-installed) run:

$ git clone https://github.com/heremaps/here-map-widget-for-jupyter.git
$ cd here-map-widget-for-jupyter
$ pip install -e .
$ jupyter nbextension install --py --symlink --sys-prefix here_map_widget
$ jupyter nbextension enable --py --sys-prefix here_map_widget
$ jupyter labextension install @jupyter-widgets/jupyterlab-manager js

If you are actively developing your extension, we recommend you build JupyterLab with the command below:

$ jupyter lab --watch

It does take a minute or so to get started, but then hot-reload your JavaScript extension changes. For every change, save your JavaScript and then watch the terminal for an update.

Note on first jupyter lab --watch, you may need to touch a file to get Jupyter Lab to open.

Documentation

A collection of example notebooks is provided in the /examples directory.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

here-map-widget-for-jupyter-0.1.0.tar.gz (2.6 MB view details)

Uploaded Source

Built Distribution

here_map_widget_for_jupyter-0.1.0-py2.py3-none-any.whl (4.2 MB view details)

Uploaded Python 2 Python 3

File details

Details for the file here-map-widget-for-jupyter-0.1.0.tar.gz.

File metadata

  • Download URL: here-map-widget-for-jupyter-0.1.0.tar.gz
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for here-map-widget-for-jupyter-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ee830736e93a935ed2b2aee7c023a6b8e8de0f7a9c6cf212b2e918b1351eebf0
MD5 0a6723c12d33419f6825030c77e9d5c3
BLAKE2b-256 ede0a81e632caf61b280ce383011a0c67abf5a67b1d6ab87df3d2a152ab2897b

See more details on using hashes here.

File details

Details for the file here_map_widget_for_jupyter-0.1.0-py2.py3-none-any.whl.

File metadata

  • Download URL: here_map_widget_for_jupyter-0.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 4.2 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for here_map_widget_for_jupyter-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9879c8e8c37ff65a7d15c921c4ff41e744ddf9a381b04c86987fb6fc0841b908
MD5 caa0e28941614c47e774467262be87de
BLAKE2b-256 0a70efcb7b217cbee4cc1a925de1ef401b8dd1fee9aeaa54c5c615d20643af0a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page