⬇️ Installation

Get started with localtileserver to view rasters locally in Jupyter or deploy as your own FastAPI application.

🐍 Installing with conda

Conda makes managing localtileserver’s dependencies across platforms quite easy and this is the recommended method to install:

conda install -c conda-forge localtileserver ipyleaflet

🎡 Installing with pip

If you prefer pip, then you can install from PyPI: https://pypi.org/project/localtileserver/

pip install localtileserver ipyleaflet

📦 Optional Dependencies

localtileserver provides several optional dependency groups for extended functionality:

Xarray/DataArray support (NetCDF, Zarr tile serving):

pip install localtileserver[xarray]

This installs xarray and rioxarray for serving tiles directly from xarray DataArrays.

Jupyter widget integration:

pip install localtileserver[jupyter]

This installs jupyter-server-proxy and ipyleaflet.

Additional colormaps:

pip install localtileserver[colormaps]

This installs matplotlib, cmocean, and colorcet for a wide range of scientific colormaps.

Geometry helpers:

pip install localtileserver[helpers]

This installs shapely for geometry conversion utilities.