Skip to content

Commit 3705b03

Browse files
authored
DOCS: Make the relationship between this and stackstac explicit (#6)
1 parent f671d9d commit 3705b03

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# xpystac
2-
For extending `xarray.open_dataset` to accept pystac objects
2+
xpystac provides the glue that allows `xarray.open_dataset` to accept pystac objects.
3+
4+
The goal is that as long as this library is in your env, you should never need to think about it.
35

46
## Example
57

@@ -25,6 +27,12 @@ xr.open_dataset(search, engine="stac")
2527
pip install git+https://github.com/jsignell/xpystac
2628
```
2729

30+
## How it works
31+
32+
When you call ``xarray.open_dataset(object, engine="stac")`` this library maps that open call to the correct library.
33+
Depending on the ``type`` of ``object`` that might be [stackstac](https://github.com/gjoseph92/stackstac)
34+
or back to ``xarray.open_dataset`` itself but with the engine and other options pulled from the pystac object.
35+
2836
## Prior Art
2937

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

0 commit comments

Comments
 (0)