Plots get labels from pint arrays #5561

TomNicholas · 2021-07-02T00:44:28Z

Stops you needing to call .pint.dequantify() before plotting.

Builds on top of #5568, so that should be merged first.

Closes (1) from sparse and other duck array issues #3245 (comment)
Tests added
Tests passing
Passes pre-commit run --all-files
User visible changes (including notable bug fixes) are documented in whats-new.rst

pep8speaks · 2021-07-02T00:44:34Z

Hello @TomNicholas! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2021-07-21 22:08:37 UTC

github-actions · 2021-07-02T00:49:09Z

Unit Test Results

        6 files ±0         6 suites ±0 53m 47s ⏱️ ±0s
16 204 tests ±0 14 469 ✔️ ±0 1 735 💤 ±0 0 ❌ ±0
90 420 runs ±0 82 245 ✔️ ±0 8 175 💤 ±0 0 ❌ ±0

Results for commit 92cb751. ± Comparison against base commit 92cb751.

♻️ This comment has been updated with latest results.

TomNicholas · 2021-07-02T03:23:41Z

I thought this approach was neat but it seems to have broken some of the tests in test_units...

TomNicholas · 2021-07-02T14:02:46Z

This should be reimplemented following #3245 (comment). Really another PR should be opened to implement a to_duck_array method and to_numpy, and this PR rebased on top of that to coerce arrays before plotting.

…o_numpy()

TomNicholas · 2021-07-02T20:43:41Z

Now builds on top of #5568, but fails because that PR is not complete (does not change .values -> .to_numpy() everywhere needed yet).

keewis · 2021-07-02T07:58:06Z

xarray/tests/test_units.py

+class TestPlots(PlotTestCase):
+    def test_units_in_line_plot_labels(self):
+        arr = np.linspace(1, 10, 3) * unit_registry.Pa
+        # TODO make coord a Quantity once unit-aware indexes supported


shouldn't it be possible to specify a non-dimensional coordinate with x="x_coord"?

The point was that I want this test to eventually test labels on both the x and y axes, but at the moment pint is only involved with the y axis, right?

that's right. I meant to implement this by converting the dimension coordinate to a non-dimension coordinate:

x_coord = xr.DataArray( np.linspace(1, 3, 3) * unit_registry.m, dims="x" ) da = xr.DataArray(data=arr, dims="x", coords={"x_coord": x_coord}, name="pressure") da.plot.line(x="x_coord")

If I try that I still get a UnitStrippedWarning in .to_index_variable()

That seems like a bug. open an issue for it so we don't forget?

keewis · 2021-07-02T08:02:12Z

xarray/core/pycompat.py

+    import pint
+
+    pint_version = LooseVersion(pint.__version__)
+    pint_array_type = (pint.Quantity,)


I think this is the reason for the failures (see #4751 (comment)): we import pint here, but pint also tries to import xarray for type checking. Normally, the circular import would be an error but pytest silences that, apparently, resulting in a partially imported module.

Do you think this explains the failures in #5568 too?

Looking at this properly I see what you mean now. So is this PR just stuck then? Why can we not just check the name rather than the explicit type within xarray (for now at least)?

you could import pint in the functions that use pint_array_type for now (or add a _get_pint_array_type function to pycompat and call it wherever pint_array_type would be used), and I'll try to get pint to not import xarray (because ideally it should not care about what wraps it). Not sure if that's possible, though.

The best long term fix would be to figure out dask/dask#6635

@keewis It would be good to hear your thoughts on that over on the Pint issue tracker. Right now, to maintain the type casting hierarchy, libraries with duck arrays have to either define a list of types they can wrap (and prohibit all others) or a list which are meant to wrap it (and allow wrapping any other). Pint went with the latter since it was the safest approach as a type high on the graph (https://pint.readthedocs.io/en/stable/numpy.html#Technical-Commentary), but I suppose that if that was problematic, it could be flipped around to a list of allowed types to wrap (with a breaking change), as Dask ended up doing (dask/dask#6393).

But, definitely, this ad hoc approach to the type casting hierarchy will continue to be problematic until dask/dask#6635 is resolved definitely.

It would be really nice to fix this properly (and I will bring it up in the xarray dev call now), but for this PR then your suggestion seems to work nicely on #5568 @keewis , thanks.

… to_numpy

TomNicholas · 2021-07-16T04:04:09Z

I think this is ready to merge after #5568 is merged?

dcherian

looks great!

* main: (31 commits) Refactor index vs. coordinate variable(s) (pydata#5636) pre-commit: autoupdate hook versions (pydata#5685) Flexible Indexes: Avoid len(index) in map_blocks (pydata#5670) Speed up _mapping_repr (pydata#5661) update the link to `scipy`'s intersphinx file (pydata#5665) Bump styfle/cancel-workflow-action from 0.9.0 to 0.9.1 (pydata#5663) pre-commit: autoupdate hook versions (pydata#5660) fix the binder environment (pydata#5650) Update api.rst (pydata#5639) Kwargs to rasterio open (pydata#5609) Bump codecov/codecov-action from 1 to 2.0.2 (pydata#5633) new blank whats-new for v0.19.1 v0.19.0 release notes (pydata#5632) remove deprecations scheduled for 0.19 (pydata#5630) Make typing-extensions optional (pydata#5624) Plots get labels from pint arrays (pydata#5561) Add to_numpy() and as_numpy() methods (pydata#5568) pin fsspec (pydata#5627) pre-commit: autoupdate hook versions (pydata#5617) Add dataarray scatter with 3d support (pydata#4909) ...

* upstream/main: (31 commits) Refactor index vs. coordinate variable(s) (pydata#5636) pre-commit: autoupdate hook versions (pydata#5685) Flexible Indexes: Avoid len(index) in map_blocks (pydata#5670) Speed up _mapping_repr (pydata#5661) update the link to `scipy`'s intersphinx file (pydata#5665) Bump styfle/cancel-workflow-action from 0.9.0 to 0.9.1 (pydata#5663) pre-commit: autoupdate hook versions (pydata#5660) fix the binder environment (pydata#5650) Update api.rst (pydata#5639) Kwargs to rasterio open (pydata#5609) Bump codecov/codecov-action from 1 to 2.0.2 (pydata#5633) new blank whats-new for v0.19.1 v0.19.0 release notes (pydata#5632) remove deprecations scheduled for 0.19 (pydata#5630) Make typing-extensions optional (pydata#5624) Plots get labels from pint arrays (pydata#5561) Add to_numpy() and as_numpy() methods (pydata#5568) pin fsspec (pydata#5627) pre-commit: autoupdate hook versions (pydata#5617) Add dataarray scatter with 3d support (pydata#4909) ...

* upstream/main: (34 commits) Use same bool validator as other inputs (pydata#5703) conditionally disable bottleneck (pydata#5560) Refactor index vs. coordinate variable(s) (pydata#5636) pre-commit: autoupdate hook versions (pydata#5685) Flexible Indexes: Avoid len(index) in map_blocks (pydata#5670) Speed up _mapping_repr (pydata#5661) update the link to `scipy`'s intersphinx file (pydata#5665) Bump styfle/cancel-workflow-action from 0.9.0 to 0.9.1 (pydata#5663) pre-commit: autoupdate hook versions (pydata#5660) fix the binder environment (pydata#5650) Update api.rst (pydata#5639) Kwargs to rasterio open (pydata#5609) Bump codecov/codecov-action from 1 to 2.0.2 (pydata#5633) new blank whats-new for v0.19.1 v0.19.0 release notes (pydata#5632) remove deprecations scheduled for 0.19 (pydata#5630) Make typing-extensions optional (pydata#5624) Plots get labels from pint arrays (pydata#5561) Add to_numpy() and as_numpy() methods (pydata#5568) pin fsspec (pydata#5627) ...

* upstream/main: (307 commits) Use same bool validator as other inputs (pydata#5703) conditionally disable bottleneck (pydata#5560) Refactor index vs. coordinate variable(s) (pydata#5636) pre-commit: autoupdate hook versions (pydata#5685) Flexible Indexes: Avoid len(index) in map_blocks (pydata#5670) Speed up _mapping_repr (pydata#5661) update the link to `scipy`'s intersphinx file (pydata#5665) Bump styfle/cancel-workflow-action from 0.9.0 to 0.9.1 (pydata#5663) pre-commit: autoupdate hook versions (pydata#5660) fix the binder environment (pydata#5650) Update api.rst (pydata#5639) Kwargs to rasterio open (pydata#5609) Bump codecov/codecov-action from 1 to 2.0.2 (pydata#5633) new blank whats-new for v0.19.1 v0.19.0 release notes (pydata#5632) remove deprecations scheduled for 0.19 (pydata#5630) Make typing-extensions optional (pydata#5624) Plots get labels from pint arrays (pydata#5561) Add to_numpy() and as_numpy() methods (pydata#5568) pin fsspec (pydata#5627) ...

TomNicholas added 3 commits July 1, 2021 20:00

test labels come from pint units

ec3040e

values demotes pint arrays before returning

6bb4298

plot labels look for pint units first

04d78c5

TomNicholas mentioned this pull request Jul 2, 2021

add a plotting example xarray-contrib/pint-xarray#61

Merged

pre-commit

6fee339

TomNicholas requested a review from keewis July 2, 2021 00:49

TomNicholas removed the request for review from keewis July 2, 2021 03:16

TomNicholas requested a review from keewis July 2, 2021 03:23

keewis mentioned this pull request Jul 2, 2021

hooks to "prepare" xarray objects for plotting #5562

Open

TomNicholas removed the request for review from keewis July 2, 2021 14:02

TomNicholas added 4 commits July 2, 2021 16:16

added to_numpy() and as_numpy() methods

17c5755

remove special-casing of cupy arrays in .values in favour of using .t…

48ba107

…o_numpy()

merged to_numpy() method in

531385b

.values -> .to_numpy()

9cb2f9b

TomNicholas added the topic-arrays related to flexible array support label Jul 2, 2021

max-sixty added 2 commits July 2, 2021 14:54

lint

ae6e931

Fix mypy (I think?)

dc24d3f

keewis reviewed Jul 3, 2021

View reviewed changes

TomNicholas added 6 commits July 3, 2021 18:43

Merge branch 'main' of https://github.com/pydata/xarray into to_numpy

6ce6b05

Merge branch 'to_numpy' of https://github.com/TomNicholas/xarray into…

04d7b02

… to_numpy

added Dataset.as_numpy()

ee34649

improved docstrings

552b322

add what's new

1215e69

add to API docs

af8a1ee

TomNicholas added 2 commits July 7, 2021 15:26

pycompat import changes applied to plotting code

3f85e21

what's new

e397168

TomNicholas mentioned this pull request Jul 8, 2021

Release v0.19? #5588

Closed

8 tasks

TomNicholas added 3 commits July 8, 2021 15:23

compute instead of load

45245d0

added tests

27fc4e5

fixed sparse test

3e8cb24

TomNicholas mentioned this pull request Jul 9, 2021

Call .compute() in all plot methods? #5589

Open

TomNicholas added 11 commits July 9, 2021 12:20

tests and fixes for ds.as_numpy()

f9d6370

fix sparse tests

50fdf4c

fix linting

1c94a97

tests for Variable

2d07c0f

test IndexVariable too

9673cea

use numpy.asarray to avoid a copy

0d624cc

also convert coords

2f1ff46

Merge branch 'main' into to_numpy

afd35e2

Force tests again after pydata#5600

6d33b35

Merge branch 'main' into to_numpy

eae95f5

Merge branch 'to_numpy' into unit-free-values

36f3bd9

TomNicholas added the plan to merge Final call for comments label Jul 16, 2021

dcherian approved these changes Jul 16, 2021

View reviewed changes

merged main

4c53790

TomNicholas merged commit 92cb751 into pydata:main Jul 21, 2021

caenrigen mentioned this pull request Oct 15, 2021

Display coords' units for slice plots #5847

Merged

3 tasks

TomNicholas mentioned this pull request Oct 22, 2021

Use .to_numpy() for quantified facetgrids #5886

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Plots get labels from pint arrays #5561

Plots get labels from pint arrays #5561

TomNicholas commented Jul 2, 2021 •

edited

Loading

pep8speaks commented Jul 2, 2021 •

edited

Loading

github-actions bot commented Jul 2, 2021 •

edited

Loading

TomNicholas commented Jul 2, 2021

TomNicholas commented Jul 2, 2021 •

edited

Loading

TomNicholas commented Jul 2, 2021

keewis Jul 2, 2021

TomNicholas Jul 3, 2021

keewis Jul 4, 2021

TomNicholas Jul 6, 2021

dcherian Jul 16, 2021

keewis Jul 2, 2021

TomNicholas Jul 4, 2021

TomNicholas Jul 6, 2021

keewis Jul 6, 2021 •

edited

Loading

jthielen Jul 6, 2021

TomNicholas Jul 7, 2021 •

edited

Loading

TomNicholas commented Jul 16, 2021

dcherian left a comment

Plots get labels from pint arrays #5561

Plots get labels from pint arrays #5561

Conversation

TomNicholas commented Jul 2, 2021 • edited Loading

pep8speaks commented Jul 2, 2021 • edited Loading

Comment last updated at 2021-07-21 22:08:37 UTC

github-actions bot commented Jul 2, 2021 • edited Loading

Unit Test Results

TomNicholas commented Jul 2, 2021

TomNicholas commented Jul 2, 2021 • edited Loading

TomNicholas commented Jul 2, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

keewis Jul 6, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TomNicholas Jul 7, 2021 • edited Loading

Choose a reason for hiding this comment

TomNicholas commented Jul 16, 2021

dcherian left a comment

Choose a reason for hiding this comment

TomNicholas commented Jul 2, 2021 •

edited

Loading

pep8speaks commented Jul 2, 2021 •

edited

Loading

github-actions bot commented Jul 2, 2021 •

edited

Loading

TomNicholas commented Jul 2, 2021 •

edited

Loading

keewis Jul 6, 2021 •

edited

Loading

TomNicholas Jul 7, 2021 •

edited

Loading