Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jupyter-xeus/xleaflet

C++ backend for the jupyter leaflet widget
https://github.com/jupyter-xeus/xleaflet

Last synced: 20 days ago
JSON representation

C++ backend for the jupyter leaflet widget

Host: GitHub
URL: https://github.com/jupyter-xeus/xleaflet
Owner: jupyter-xeus
License: bsd-3-clause
Created: 2018-03-30T16:37:54.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2024-05-31T16:04:59.000Z (7 months ago)
Last Synced: 2024-11-14T19:02:52.923Z (29 days ago)
Language: C++
Size: 19 MB
Stars: 84
Watchers: 8
Forks: 16
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-starred - jupyter-xeus/xleaflet - C++ backend for the jupyter leaflet widget (others)

README

        # ![xleaflet](docs/source/xleaflet.svg)

[![Azure Pipelines](https://dev.azure.com/jupyter-xeus/jupyter-xeus/_apis/build/status/jupyter-xeus.xleaflet?branchName=master)](https://dev.azure.com/jupyter-xeus/jupyter-xeus/_build/latest?definitionId=7&branchName=master)

[![Appveyor](https://ci.appveyor.com/api/projects/status/u3tf1pk8fw2nge7a?svg=true)](https://ci.appveyor.com/project/jupyter-xeus/xleaflet)

[![Documentation](http://readthedocs.org/projects/xleaflet/badge/?version=latest)](https://xleaflet.readthedocs.io/en/latest/?badge=latest)

[![Binder](https://img.shields.io/badge/launch-binder-brightgreen.svg)](https://mybinder.org/v2/gh/jupyter-xeus/xleaflet/stable?filepath=notebooks)

[![Join the Gitter Chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/QuantStack/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

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

## Usage

Selecting a base layer for a map:

![Basemap Screencast](basemap.gif)

Loading a geojson dataset:

![GeoJSON Screencast](geojson.gif)

Using the splitmap control:

![Splitmap Screencast](splitmap.gif)

Displaying velocity data on the top of a map:

![Velocity Screencast](velocity.gif)

## Installation

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

- Installing `xleaflet` and the C++ kernel

```bash

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:

```bash

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](docs/source/binder-logo.svg)](https://mybinder.org/v2/gh/jupyter-xeus/xleaflet/stable?filepath=notebooks/)

## 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](LICENSE) file for details.