titiler.xarray
Adds support for Xarray Dataset (NetCDF/Zarr) in Titiler.
Installation
python -m pip install -U pip
# From Pypi
python -m pip install "titiler.xarray[full]"
# Or from sources
git clone https://github.com/developmentseed/titiler.git
cd titiler && python -m pip install -e src/titiler/core -e "src/titiler/xarray"
Installation options
Default installation for titiler.xarray DOES NOT include fsspec or any storage's specific dependencies (e.g s3fs) nor engine dependencies (zarr, h5netcdf). This is to ease the customization and deployment of user's applications. If you want to use the default's dataset reader you will need to at least use the [minimal] dependencies (e.g python -m pip install "titiler.xarray[minimal]").
Here is the list of available options:
- fs:
h5netcdf,fsspec,s3fs,aiohttp,gcsfs
Dependencies
Titiler.xarray follows SPEC 0, similar to xarray.
How To
from fastapi import FastAPI
from titiler.xarray.extensions import VariablesExtension
from titiler.xarray.factory import TilerFactory
app = FastAPI(
openapi_url="/api",
docs_url="/api.html",
description="""Xarray based tiles server for MultiDimensional dataset (Zarr/NetCDF).
---
**Documentation**: <a href="https://developmentseed.org/titiler/" target="_blank">https://developmentseed.org/titiler/</a>
**Source Code**: <a href="https://github.com/developmentseed/titiler" target="_blank">https://github.com/developmentseed/titiler</a>
---
""",
)
md = TilerFactory(
router_prefix="/md",
extensions=[
VariablesExtension(),
],
)
app.include_router(md.router, prefix="/md", tags=["Multi Dimensional"])
Package structure
titiler/
└── xarray/
├── tests/ - Tests suite
└── titiler/xarray/ - `xarray` namespace package
├── dependencies.py - titiler-xarray dependencies
├── extensions.py - titiler-xarray extensions
├── main.py - main fastapi application
├── io.py - titiler-xarray Readers
└── factory.py - endpoints factory
Custom Dataset Opener
A default Dataset IO is provided within titiler.xarray.io.Reader class with only support for Zarr dataset (via xarray+zarr-python).
For other dataset (e.g NetCDF), you can use titiler.xarray.io.FsReader which use the optional dependencies (fsspec, netcdf5).
python -m pip install "titiler.xarray[fs]"
Example of application with fsspec reader:
from fastapi import FastAPI
from titiler.xarray.extensions import VariablesExtension
from titiler.xarray.factory import TilerFactory
from titiler.xarray.io import FsReader
# Create FastAPI application
app = FastAPI(openapi_url="/api", docs_url="/api.html")
# Create custom endpoints with the FsReader
md = TilerFactory(
reader=FsReader,
router_prefix="/md",
extensions=[
# we also want to use the simple opener for the Extension
VariablesExtension(dataset_opener=xarray.open_dataset),
],
)
app.include_router(md.router, prefix="/md", tags=["Multi Dimensional"])
Release files for titiler-xarray 2.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| titiler_xarray-2.3.0.tar.gz | 32.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| titiler_xarray-2.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 66.8 kB
Release files / titiler_xarray-2.3.0.tar.gz
| Download URL | titiler_xarray-2.3.0.tar.gz |
|---|---|
| Size | 32.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bf48d2883033ec544c0eaf818a94732209fafa4c15676f4793ea00f9273edc00
|
|
BLAKE2b-256 checksum How to use checksums |
e628483b59bdcc6fa19c6d9ee1c3aad9f0f9d385610e07b41a2db66926abf9d9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.
Transparency logRelease files / titiler_xarray-2.3.0-py3-none-any.whl
| Download URL | titiler_xarray-2.3.0-py3-none-any.whl |
|---|---|
| Size | 34.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
78d9277ddfc54f7940140d0d8abe4225af52577c3a0f810cb57ba7d60118da01
|
|
BLAKE2b-256 checksum How to use checksums |
bf37da62b43f3301bc5f66d0f2f7e2df266befb7ea3920cc3714bd38e351cd5a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.
Transparency log
