đ localtileserver
==================
.. toctree::
:hidden:
installation/index
user-guide/index
api/index
*Need to visualize a rather large (gigabytes+) raster?* **This is for you.**
Try it out below!
.. jupyter-execute::
from localtileserver import TileClient, get_leaflet_tile_layer, examples
from ipyleaflet import Map
# Create a TileClient from a raster file
# client = TileClient('path/to/geo.tif')
client = examples.get_san_francisco() # use example data
# Create ipyleaflet TileLayer from that server
t = get_leaflet_tile_layer(client)
# Create ipyleaflet map, add tile layer, and display
m = Map(center=client.center(), zoom=client.default_zoom)
m.add(t)
m
.. raw:: html
A Python package for serving tiles from large raster files in
the `Slippy Maps standard `_
(i.e., `/zoom/x/y.png`) for visualization in Jupyter with ``ipyleaflet`` or ``folium``.
.. |binder| image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/banesullivan/localtileserver-demo/HEAD
:alt: MyBinder
Launch a `demo `_ on MyBinder |binder|
Built on `rio-tiler `_.
đ Highlights
=============
- Launch a tile server for large geospatial images
- View local or remote* raster files with ``ipyleaflet`` or ``folium`` in Jupyter
- View rasters with CesiumJS with the built-in web application
*remote raster files should be pre-tiled Cloud Optimized GeoTiffs*
âšī¸ Overview
===========
The :class:`TileClient` class can be used to to launch a tile server in a background
thread which will serve raster imagery to a viewer (see ``ipyleaflet`` and
``folium`` examples in :ref:`user_guide`).
This tile server can efficiently deliver varying resolutions of your
raster imagery to your viewer; it helps to have pre-tiled,
`Cloud Optimized GeoTIFFs (COG) `_.
There is an included, standalone web viewer leveraging
`CesiumJS `_.
đĒĸ Community Usage
==================
- `leafmap `_ and `geemap `_: use localtileserver for visualizing large raster images in a Jupyter-based geospatial mapping application
- `streamlit-geospatial `_: uses localtileserver's remote tile server for viewing image tiles
- `remotetileserver `_: uses the core flask application to spin up a production ready tile server
- `Kaustav Mukherjee's blog post `_: a user-created demonstration on how to get started with localtileserver
- `Serving up SpaceNet Imagery for Bokeh `_: Adam Van Etten's blog post using localtileserver to view imagery with Bokeh