Xpublish lets you easily publish Xarray Datasets via a REST API.
You can run a short example application in a live session here:
On the server-side, one or more datasets can be published using the
xpublish.Rest class or the
xarray.Dataset.rest accessor, e.g.,
Those datasets can be accessed from various kinds of client applications, e.g., from within Python using Zarr and fsspec.
import xarray as xr import zarr from fsspec.implementations.http import HTTPFileSystem fs = HTTPFileSystem() http_map = fs.get_mapper('http://0.0.0.0:9000') # open as a zarr group zg = zarr.open_consolidated(http_map, mode='r') # or open as another Xarray Dataset ds = xr.open_zarr(http_map, consolidated=True)
Xpublish lets you serve, share and publish Xarray Datasets via a web application.
The data and/or metadata in the Xarray Datasets can be exposed in various forms through pluggable REST API endpoints. Efficient, on-demand delivery of large datasets may be enabled with Dask on the server-side.
We are exploring applications of Xpublish that include:
publish on-demand or derived data products
turning xarray objects into streaming services (e.g. OPeNDAP)
Under the hood, Xpublish is using a web app (FastAPI and Uvicorn) that is exposing a REST-like API with builtin and/or user-defined endpoints.
For example, Xpublish provides by default a minimal Zarr compatible REST-like API with the following endpoints:
/.zmetadata: returns Zarr-formatted metadata keys as json strings.
/var/0.0.0: returns a variable data chunk as a binary string.
If you encounter any errors or problems with Xpublish, please open an issue on GitHub.