Skip to content
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

document the duck array integration status #4530

Merged
merged 22 commits into from
Nov 20, 2020

Conversation

keewis
Copy link
Collaborator

@keewis keewis commented Oct 23, 2020

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 of xarray which right now won't work with duck arrays, and to start maintaining a list of extensions like pint-xarray.

The remaining issues are taken from #3594, but I'm sure I missed something (e.g. plotting).

  • Passes isort . && black . && mypy . && flake8
  • User visible changes (including notable bug fixes) are documented in whats-new.rst

@keewis keewis changed the title WIP: document the duck array integration status document the duck array integration status Oct 24, 2020
@keewis keewis marked this pull request as ready for review October 24, 2020 13:11
@keewis
Copy link
Collaborator Author

keewis commented Oct 24, 2020

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.

doc/duckarrays.rst Outdated Show resolved Hide resolved
doc/terminology.rst Show resolved Hide resolved
Comment on lines +13 to +14
: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`).
Copy link
Collaborator Author

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?

Copy link
Contributor

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.

Copy link
Collaborator

@max-sixty max-sixty left a 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

@keewis
Copy link
Collaborator Author

keewis commented Oct 26, 2020

I just noticed that we have to wrap chunk calls with a dequantify / quantify cycle if we want to have it work correctly, but maybe that's something that belongs into the pint-xarray docs?

@keewis keewis mentioned this pull request Oct 29, 2020
18 tasks
@keewis
Copy link
Collaborator Author

keewis commented Oct 31, 2020

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.

@keewis keewis mentioned this pull request Nov 6, 2020
2 tasks
doc/terminology.rst Outdated Show resolved Hide resolved
doc/terminology.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@dcherian dcherian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@dcherian dcherian merged commit a219215 into pydata:master Nov 20, 2020
@keewis keewis deleted the duckarray-docs branch November 20, 2020 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants