Skip to content
This repository was archived by the owner on Oct 24, 2024. It is now read-only.

Commit 0afaa6c

Browse files
committed
add migration notice to readme
1 parent 03b0a8c commit 0afaa6c

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ that was more flexible than a single `xarray.Dataset` object.
1414
The initial motivation was to represent netCDF files / Zarr stores with multiple nested groups in a single in-memory object,
1515
but `datatree.DataTree` objects have many other uses.
1616

17+
### DEPRECATION NOTICE
18+
19+
Datatree is in the process of being merged upstream into xarray (as of [v0.0.14](https://github.com/xarray-contrib/datatree/releases/tag/v0.0.14), see xarray issue [#8572](https://github.com/pydata/xarray/issues/8572)). We are aiming to preserve the record of contributions to this repository during the migration process. However whilst we will hapily accept new PRs to this repository, this repo will be deprecated and any PRs since [v0.0.14](https://github.com/xarray-contrib/datatree/releases/tag/v0.0.14) might be later copied across to xarray without full git attribution.
20+
21+
Hopefully for users the disruption will be minimal - and just mean that in some future version of xarray you only need to do `from xarray import DataTree` rather than `from datatree import DataTree`. Once the migration is complete this repository will be archived.
22+
1723
### Installation
1824
You can install datatree via pip:
1925
```shell

0 commit comments

Comments
 (0)