README.md

October 27, 2025 ยท View on GitHub

GithubActions Documentation Binder Zulip

C++ backend for the jupyter-leaflet map visualization library

Usage

Selecting a base layer for a map:

Basemap Screencast

Loading a geojson dataset:

GeoJSON Screencast

Using the splitmap control:

Splitmap Screencast

Displaying velocity data on the top of a map:

Velocity Screencast

Installation

We provide a package for the mamba (or conda) package manager.

  • Installing xleaflet and the C++ kernel
mamba install xeus-cling xleaflet -c conda-forge

Then, the front-end extension must be installed for either the classic notebook or JupyterLab.

  • Installing the extensions for the classic notebook
mamba install widgetsnbextension -c conda-forge
mamba install ipyleaflet -c conda-forge
  • Installing the JupyterLab extension
jupyter labextension install @jupyter-widgets/jupyterlab-manager
jupyter labextension install jupyter-leaflet

Installation from sources

Or you can directly install it from the sources if you have all the dependencies already installed:

cmake -D CMAKE_INSTALL_PREFIX=your_install_prefix
make install

Trying it online

To try out xleaflet interactively in your web browser, just click on the binder link:

Binder

Documentation

To get started with using xleaflet, check out the full documentation

http://xleaflet.readthedocs.io/

License

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.