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

https://github.com/kitware/trame-deckgl

Deck.gl widget for trame
https://github.com/kitware/trame-deckgl

trame trame-maintenance-program

Last synced: 12 months ago
JSON representation

Deck.gl widget for trame

Awesome Lists containing this project

README

          

.. |pypi_download| image:: https://img.shields.io/pypi/dm/trame-deckgl

High-scale spatial rendering for trame |pypi_download|
===========================================================================

.. image:: https://github.com/Kitware/trame-deckgl/actions/workflows/test_and_release.yml/badge.svg
:target: https://github.com/Kitware/trame-deckgl/actions/workflows/test_and_release.yml
:alt: Test and Release

trame-deckgl extend trame **widgets** with components that can interface with PyDeck while being powered by Deck.gl.
Deck integration in trame allow you to create rich visualization by leveraging `PyDeck `_ (`Apache License `_).

Installing
-----------------------------------------------------------

trame-deckgl can be installed with `pip `_:

.. code-block:: bash

pip install --upgrade trame-deckgl

Usage
-----------------------------------------------------------

The `Trame Tutorial `_ is the place to go to learn how to use the library and start building your own application.

The `API Reference `_ documentation provides API-level documentation.

License
-----------------------------------------------------------

trame-deckgl is made available under the MIT License. For more details, see `LICENSE `_
This license has been chosen to match the one use by `Deck.gl `_ which is use within trame-deckgl.

Community
-----------------------------------------------------------

`Trame `_ | `Discussions `_ | `Issues `_ | `RoadMap `_ | `Contact Us `_

.. image:: https://zenodo.org/badge/410108340.svg
:target: https://zenodo.org/badge/latestdoi/410108340

Enjoying trame?
-----------------------------------------------------------

Share your experience `with a testimonial `_ or `with a brand approval `_.

Example: PyDeck
-----------------------------------------------------------

The Deck component relies on the server for generating the map definition.

.. code-block:: python

import pydeck as pdk
from trame.widgets import deckgl

deck = pdk.Deck(
map_provider="mapbox",
map_style="mapbox://styles/mapbox/light-v9",
initial_view_state={
"latitude": 37.76,
"longitude": -122.4,
"zoom": 11,
"pitch": 50,
},
layers=selected_layers,
)

widget = deckgl.Deck(mapboxApiKey=..., deck=deck)
widget.update(deck2)

JavaScript dependency
-----------------------------------------------------------

This Python package bundle the ``@deck.gl/jupyter-widget@8.4.7`` JavaScript library. If you would like us to upgrade it, `please reach out `_.