A Jupyter / Leaflet bridge enabling interactive maps in the Jupyter notebook.
Selecting a basemap for a leaflet map:
Loading a geojson map:
Making use of leafletjs primitives:
Using the splitmap control:
Displaying velocity data on the top of a map:
Using conda:
$ conda install -c conda-forge ipyleaflet
Using pip:
$ pip install ipyleaflet
$ jupyter nbextension enable --py --sys-prefix ipyleaflet # can be skipped for
notebook 5.3 and above
If you have JupyterLab, you will also need to install the JupyterLab extension:
$ jupyter labextension install jupyter-leaflet
Some users have found that the jupyterlab-manager
is also required
in jupyterlab if the map does not display.
$ jupyter labextension install @jupyter-widgets/jupyterlab-manager
For a development installation (requires npm):
$ git clone https://github.com/jupyter-widgets/ipyleaflet.git
$ cd ipyleaflet
$ pip install -e .
$ jupyter nbextension install --py --symlink --sys-prefix ipyleaflet
$ jupyter nbextension enable --py --sys-prefix ipyleaflet
Note for developers: the --symlink
argument on Linux or OS X allows one to
modify the JavaScript code in-place. This feature is not available
with Windows.
To get started with using ipyleaflet
, check out the full documentation
https://ipyleaflet.readthedocs.io/
We use a shared copyright model that enables all contributors to maintain the copyright on their contributions.
This software is licensed under the BSD-3-Clause license. See the LICENSE file for details.
The ipyleaflet
repository includes the jupyter-leaflet
npm package, which
is a front-end component, and the ipyleaflet
python package which is the
backend for the Python Jupyter kernel.
Similarly, the xleaflet
project
provides a backend to jupyter-leaflet
for the "xeus-cling" C++ Jupyter
kernel.