Skip to content
This repository was archived by the owner on Jun 4, 2025. It is now read-only.

Commit 1e68a58

Browse files
Deprecation notice (#11)
* Deprecation notice This deprecates the xarray-assets extension. The deprecation notice includes recommendations to use some other extensions and libraries that would need to exist for us to actually have an alternative (I'm not planning to work on those, but chime in here if you want to). Closes #9 * Update README.md --------- Co-authored-by: Matthias Mohr <[email protected]>
1 parent bcd3934 commit 1e68a58

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,22 @@
44
- **Identifier:** <https://stac-extensions.github.io/xarray-assets/v1.0.0/schema.json>
55
- **Field Name Prefix:** xarray
66
- **Scope:** Asset
7-
- **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Pilot
7+
- **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Deprecated
88
- **Owner**: @TomAugspurger
99

10+
11+
# Deprecation Notice
12+
13+
This extension has been deprecated. While useful, it ended up being to specific to xarray and Python.
14+
Instead of this extension, we recommend the following extensions and libraries to enable opening
15+
xarray Datasets from a STAC item / asset:
16+
17+
1. A yet to create `zarr` extension to capture metadata about a Zarr hierarchy, like whether it is `consolidated`. Proposals are welcome.
18+
2. The [`storage` extension](https://github.com/stac-extensions/storage) for additional storage-specific information
19+
3. The [xpystac](https://github.com/stac-utils/xpystac) library for opening xarray datasets from STAC metadata, rather than manually extracting information and calling `xarray.open_dataset` directly.
20+
21+
# Description
22+
1023
This document explains the xarray Assets Extension to the
1124
[SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification.
1225

0 commit comments

Comments
 (0)