Cleanup (mostly documentation)

[shoyer]

No description provided.

[shoyer]

CC @jhamman

It would be awesome if you could update your example to work on xray 0.4 before I do the final release (there will be a release candidate).

I think the main change effecting this example that is that 'time.season' now returns strings like 'DFJ', not integers. See http://xray.readthedocs.org/en/latest/whats-new.html for more details.

[jhamman]

@shoyer: I just ran the example and it still works without any modifications.

A few comments/questions:

• Should season be listed in the "virtual variables" here: http://xray.readthedocs.org/en/latest/data-structures.html
• With the addition of the nan-safe functions, numpy is throwing a lot of warnings for things like "empty slices" (ocean grid cells in my example never have data). Its not a big deal to silence them but it is a bit annoying.
• Since ds.groupby('time.season').mean('time') returns a Dataset with a Coordinates variable named time.season, ds.sel(time.season='JJA') doesn't work for Python syntax reasons. So, I don't know if I would change the syntax used in my example (selecting my position). I'm not keen on this constructor: ds.sel(**{'time.season':'JJA'}). I'm wondering if it would be better to name the coordinates returned from "virtual variable" operations without the "time." portion. Just a thought.

I will still get you an updated version of the example.

[shoyer]

Should season be listed in the "virtual variables" here: http://xray.readthedocs.org/en/latest/data-structures.html

Good catch

With the addition of the nan-safe functions, numpy is throwing a lot of warnings for things like "empty slices" (ocean grid cells in my example never have data). Its not a big deal to silence them but it is a bit annoying.

To fix this, you can install bottleneck (which will also make these operations much faster). We could also look into silencing the warnings. I'll add a note to the documentation somewhere.

Since ds.groupby('time.season').mean('time') returns a Dataset with a Coordinates variable named time.season, ds.sel(time.season='JJA') doesn't work for Python syntax reasons. So, I don't know if I would change the syntax used in my example (selecting my position). I'm not keen on this constructor: ds.sel(**{'time.season':'JJA'}). I'm wondering if it would be better to name the coordinates returned from "virtual variable" operations without the "time." portion. Just a thought.

This one is trickier. Let me make a new issue.