jupyter-xeus / xleaflet

C++ backend for the jupyter leaflet widget

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

Usage

Selecting a base layer for a map:

Loading a geojson dataset:

Using the splitmap control:

Displaying velocity data on the top of a map:

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:

Documentation

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

http://xleaflet.readthedocs.io/

Dependencies

All the dependencies of xleaflet are available for the mamba package manager.

xleaflet	xwidgets	xeus	xtensor
master	~0.27.0	>=3.0.0,<4.0.0	>=0.23.0,<0.24
0.17.0	~0.27.0	>=3.0.0,<4.0.0	>=0.23.0,<0.24
0.16.0	~0.26.0	>=2.0.0,<3.0.0	>=0.23.0,<0.24
0.15.0	~0.25.0	>=1.0.0,<2.0.0	>=0.23.0,<0.24
0.14.0	~0.25.0	>=1.0.0,<2.0.0	>=0.23.0,<0.24
0.13.1	~0.22.0	>=0.24.0,<0.26	>=0.20.8,<0.22
0.13.0	~0.22.0	>=0.24.0,<0.26	>=0.20.8,<0.22
0.12.0	~0.22.0	>=0.24.0,<0.25	>=0.20.8,<0.22

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.

xleaflet's Issues

Draw control doesn't work

draw_control doesn't seem to work: https://github.com/jupyter-xeus/xleaflet/blob/master/notebooks/DrawControl.ipynb

building requires xtensor, but cmake doesn't look for it

Draggable attribute for markers does not work

Draggable attribute for markers does not work

Use nlohmann::json::diff to compare ipyleaflet and xleaflet

Instead of comparing lists of attributes, this will allow us to compare default values as well.

Update ipyleaflet version to 0.10

Latest ipyleaflet/jupyter-leaflet release: 0.10.1
Current semver requirement for jupyter-leaflet : 0.9.1

https://github.com/QuantStack/xleaflet/blob/d1f606eb4d8a5fed5f4ef6effecffe7c8e97898d/include/xleaflet/xleaflet_config.hpp#L35-L38

xleaflet doesn't build on linux

xleafet doesn't build on my ArchLinux, @martinRenou was able to reproduce it on his Fedora.

Steps to reproduce are:

1. Download dependencies with conda
2. Create a build dir
3. CMake
4. make install

And get the following error:

Scanning dependencies of target xleaflet
[  3%] Building CXX object CMakeFiles/xleaflet.dir/src/xcircle_marker.cpp.o
[  6%] Building CXX object CMakeFiles/xleaflet.dir/src/xcircle.cpp.o
[  9%] Building CXX object CMakeFiles/xleaflet.dir/src/xcontrol.cpp.o
In file included from /home/mariana/.conda/envs/xleaflet/include/xproperty/xobserved.hpp:20,
                 from /home/mariana/.conda/envs/xleaflet/include/xwidgets/xobject.hpp:18,
                 from /home/mariana/Development/xleaflet/include/xleaflet/xcontrol.hpp:19,
                 from /home/mariana/Development/xleaflet/src/xcontrol.cpp:1:
/home/mariana/Development/xleaflet/include/xleaflet/xcontrol.hpp: In instantiation of ‘xlf::xcontrol<D>::xcontrol() [with D = xw::xmaterialize<xlf::xcontrol>]’:
/home/mariana/.conda/envs/xleaflet/include/xwidgets/xmaterialize.hpp:71:45:   required from ‘xw::xmaterialize<B, P>::xmaterialize(bool, A&& ...) [with A = {}; B = xlf::xcontrol; P = {}]’
/home/mariana/.conda/envs/xleaflet/include/xwidgets/xmaterialize.hpp:63:54:   required from ‘xw::xmaterialize<B, P>::xmaterialize(A&& ...) [with A = {}; B = xlf::xcontrol; P = {}]’
/home/mariana/Development/xleaflet/src/xcontrol.cpp:4:56:   required from here
/home/mariana/Development/xleaflet/include/xleaflet/xcontrol.hpp:43:67: internal compiler error: Segmentation fault
   43 | PROPERTY(std::string, derived_type, position, "topleft", XEITHER("topright", "topleft", "bottomright", "bottomleft"));
      |  

I tried to use different versions of xtensor, xeus and xwidgets but didn't make any difference.
Also tried to force the build with a different version of g++ and didn't work either.

Add an error message when basemap JSON file is not found

Add missing ipyleaflet attributes

The recently added tests by Vasavan list the attributes that are in ipyleaflet models but not xleaflet.

Throwing an exception in basemap function kills the kernel

Throwing an exception in the basemap function if the user gave an invalid path kills the kernel.

Compiler segfault on linux

@marimeireles and I have the same compiler segfault when trying to compile xleaflet master on Linux:

In file included from /home/martin/miniconda3/envs/xleaflet/include/xproperty/xobserved.hpp:20,
                 from /home/martin/miniconda3/envs/xleaflet/include/xwidgets/xobject.hpp:18,
                 from /home/martin/github/xleaflet/include/xleaflet/xcontrol.hpp:19,
                 from /home/martin/github/xleaflet/src/xcontrol.cpp:1:
/home/martin/github/xleaflet/include/xleaflet/xcontrol.hpp: In instantiation of ‘xlf::xcontrol<D>::xcontrol() [with D = xw::xmaterialize<xlf::xcontrol>]’:
/home/martin/miniconda3/envs/xleaflet/include/xwidgets/xmaterialize.hpp:71:45:   required from ‘xw::xmaterialize<B, P>::xmaterialize(bool, A&& ...) [with A = {}; B = xlf::xcontrol; P = {}]’
/home/martin/miniconda3/envs/xleaflet/include/xwidgets/xmaterialize.hpp:63:54:   required from ‘xw::xmaterialize<B, P>::xmaterialize(A&& ...) [with A = {}; B = xlf::xcontrol; P = {}]’
/home/martin/github/xleaflet/src/xcontrol.cpp:4:56:   required from here
/home/martin/github/xleaflet/include/xleaflet/xcontrol.hpp:43:67: internal compiler error: Segmentation fault
   43 |         XPROPERTY(std::string, derived_type, position, "topleft", XEITHER("topright", "topleft", "bottomright", "bottomleft"));
      |                                                                   ^~~~~~~
Please submit a full bug report,