https://github.com/stac-utils/xpystac

For extending xarray.open_dataset to accept pystac objects
https://github.com/stac-utils/xpystac

Last synced: 3 months ago
JSON representation

For extending xarray.open_dataset to accept pystac objects

• Host: GitHub
• URL: https://github.com/stac-utils/xpystac
• Owner: stac-utils
• License: mit
• Created: 2023-01-27T21:51:00.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-05T15:51:34.000Z (7 months ago)
• Last Synced: 2024-07-06T14:44:03.281Z (4 months ago)
• Language: Python
• Size: 7.67 MB
• Stars: 30
• Watchers: 3
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-earthobservation-code - xpystac - For extending xarray.open_dataset to accept pystac objects `Python` (`Python` processing of optical imagery (non deep learning) / Cloud Native Geospatial)

README

        
# xpystac

xpystac provides the glue that allows `xarray.open_dataset` to accept pystac objects.

The goal is that as long as this library is in your env, you should never need to think about it.

## Example

Search collection of COGs:

```python

import pystac_client

import xarray as xr

catalog = pystac_client.Client.open(

    "https://earth-search.aws.element84.com/v1",

)

search = catalog.search(

    intersects=dict(type="Point", coordinates=[-105.78, 35.79]),

    collections=['sentinel-2-l2a'],

    datetime="2022-04-01/2022-05-01",

)

xr.open_dataset(search, engine="stac")

```

Here are a few examples from the [Planetary Computer Docs](https://planetarycomputer.microsoft.com/docs/overview/about)

```python

import planetary_computer

import pystac_client

import xarray as xr

catalog = pystac_client.Client.open(

    "https://planetarycomputer.microsoft.com/api/stac/v1",

    modifier=planetary_computer.sign_inplace,

)

```

Read from a reference file:

```python

collection = catalog.get_collection("nasa-nex-gddp-cmip6")

asset = collection.assets["ACCESS-CM2.historical"]

xr.open_dataset(asset)

```

ref: https://planetarycomputer.microsoft.com/dataset/nasa-nex-gddp-cmip6#Example-Notebook

Read from a zarr file:

```python

collection = catalog.get_collection("daymet-daily-hi")

asset = collection.assets["zarr-abfs"]

xr.open_dataset(asset)

```

ref: https://planetarycomputer.microsoft.com/docs/quickstarts/reading-zarr-data/

## Install

```bash

pip install git+https://github.com/stac-utils/xpystac

```

## How it works

When you call ``xarray.open_dataset(object, engine="stac")`` this library maps that `open` call to the correct library.

Depending on the ``type`` of ``object`` that might be a stacking library (either

[odc-stac](https://github.com/opendatacube/odc-stac) or [stackstac](https://github.com/gjoseph92/stackstac))

or back to ``xarray.open_dataset`` itself but with the engine and other options pulled from the pystac object.

## Prior Art

This work is inspired by https://github.com/TomAugspurger/staccontainers and the discussion in https://github.com/stac-utils/pystac/issues/846