-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
document the duck array integration status #4530
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
I'm not sure "plotting" should be included in that list since converting to numpy is intentional. Other than that, this should be ready for review. |
:py:class:`DataArray` and :py:class:`Dataset` objects can wrap these duck arrays, as | ||
long as they satisfy certain conditions (see :ref:`internals.duck_arrays`). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
would it make sense to point to the explicitly tested duck arrays here (pint
, sparse
)? We could also add a user-maintained list of duck array libraries, just like the current "related projects" list.
I did think about adding usage examples, but maybe it's better to leave that to the extension packages?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think a list would be nice.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great idea, thanks @keewis
I just noticed that we have to wrap |
i.e. those which, like pint, are higher in the type hierarchy than dask.
if there are no further comments, should we merge this? I'm almost certain the list of missing features is not complete, but I would open other PRs once new items are found. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
With the initial (experimental) release of
pint-xarray
getting closer (see xarray-contrib/pint-xarray#25), I figured it might make sense to document the parts of the API ofxarray
which right now won't work with duck arrays, and to start maintaining a list of extensions likepint-xarray
.The remaining issues are taken from #3594, but I'm sure I missed something (e.g. plotting).
isort . && black . && mypy . && flake8
whats-new.rst