A Jupyter server extension providing a TiTiler server, proxy, and a Python API to add Xarray datasets to the TiTiler server.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for mfisher87 from gravatar.com mfisher87

Unverified details

These details have not been verified by PyPI
Meta
  • License: BSD License (BSD 3-Clause License)
  • Author: GeoJupyter community
  • Tags jupyter , jupyterlab , jupyterlab-extension
  • Requires: Python >=3.12
Classifiers
Report project as malware

Project description

Jupyter Xarray Tiler

PyPI - Version PyPI - Downloads License ReadTheDocs Status Github Actions Status - Build Github Actions Status - Typecheck

[!IMPORTANT] This repository is experimental and in the prototype stage. Expect bugs. Expect a possible pivot and/or name change in the future :smile:

Your feedback and contributions are welcome! Please open an issue, DM Matt Fisher, or post in the #geojupyter channel on the Jupyter Zulip!

A Jupyter server extension which provides an API to launch a server to dynamically tile Xarray DataArrays for interactive visualization.

Who is this for?

Intended to be consumed by interactive map libraries for Jupyter, not end-users, e.g.:

What problem does this solve?

For authors of interactive map libraries for Jupyter, providing a dynamic HTTP tile server presents a unique problem: they don't know where Jupyter is running. It could be, for example, running on:

  • users' local machines
  • a shared JupyterLab instance on an intranet
  • an authenticated JupyterHub in a public cloud

The first case is the simplest; when the tile server is running on localhost, the map viewer running in JavaScript in the user's browser can connect to it.

In the other cases, the map viewer needs a public URL to connect to. The URL of the current JupyterHub instance may not be known. Additionally, a map server running in a Jupyter kernel isn't exposed to the public internet in many cases (for example, when it's running in a Kubernetes pod as part of a JupyterHub). This extension provides dynamic proxying to map servers running in the kernel.

Usage

As a Jupyter interactive map library author, you may implement a method like:

from jupyter_xarray_tiler.titiler import add_data_array


class MyMapLibrary:
  # ...

  def add_xarray_layer(self, da: xr.DataArray):
    # Add the layer to the tile server.
    # The server will be started the first time this is called.
    # A URL that passes through the Jupyter server proxy will be returned:
    url = add_data_array(da)

    # Add the layer to your map!
    self._add_tile_layer(url)

Install

Recommended:

uv add jupyter-xarray-tiler

Or:

[!WARNING] Installation with pixi/conda/mamba/micromamba is not yet supported. Please use another installation method!

pixi add jupyter-xarray-tiler

For other methods of installation, including pip, conda, mamba, and micromamba, see the installation instructions in the documentation.

From source

uv add git+https://github.com/geojupyter/jupyter-xarray-tiler.git#egg=jupyter-xarray-tiler

For development instructions, please view the development install instructions in our documentation's Contributor Guide!

Contributing

Please see the Contributor Guide in our documentation!

:rocket: Powered by...

TiTiler (Development Seed)

Other backends (e.g. xpublish-tiles (earthmover)) may be supported in the future!

:sparkles: Inspired by...

jupytergis-tiler by David Brochart

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for mfisher87 from gravatar.com mfisher87

Unverified details

These details have not been verified by PyPI
Meta
  • License: BSD License (BSD 3-Clause License)
  • Author: GeoJupyter community
  • Tags jupyter , jupyterlab , jupyterlab-extension
  • Requires: Python >=3.12
Classifiers

Release history Release notifications | RSS feed

This version

0.2.0

0.1.0

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyter_xarray_tiler-0.2.0.tar.gz (254.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jupyter_xarray_tiler-0.2.0-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_xarray_tiler-0.2.0.tar.gz.

File metadata

  • Download URL: jupyter_xarray_tiler-0.2.0.tar.gz
  • Upload date:
  • Size: 254.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for jupyter_xarray_tiler-0.2.0.tar.gz
Algorithm Hash digest
SHA256 30d62c2bdf5ddbc91bcdfae16ff617c6338f92ce6e5b4fc134f605be625764d9
MD5 0a60924bb7192465abe5bc9e20be9aa3
BLAKE2b-256 981490c271c0248dcc04500be989b01ef91c65aa51bc40ab33791a0088ef3f95

See more details on using hashes here.

Provenance

The following attestation bundles were made for jupyter_xarray_tiler-0.2.0.tar.gz:

Publisher: publish.yml on geojupyter/jupyter-xarray-tiler

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file jupyter_xarray_tiler-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyter_xarray_tiler-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 688bdeaccac383fcacd24a07e2054ae8f161132c9e3918a36f281d14f39b055c
MD5 6fa2d5122cc07d6757b6131e40674fe8
BLAKE2b-256 c83dad1d91bef8b6892c6673228eec29f2279d6be57a5f97f266e3e076f3d852

See more details on using hashes here.

Provenance

The following attestation bundles were made for jupyter_xarray_tiler-0.2.0-py3-none-any.whl:

Publisher: publish.yml on geojupyter/jupyter-xarray-tiler

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page