xarray icon indicating copy to clipboard operation
xarray copied to clipboard

'Cookbook' page

Open duncanwp opened this issue 8 years ago • 8 comments

Would there be interest in adding a 'cookbook' section to the docs a-la Pandas? The current Recipes section might then be better renamed as Gallery?

It's useful for the kind of thing which isn't a full-fledged example, but might be useful nonetheless. I'll hapily put together a pull-request if there's interest.

duncanwp avatar Dec 18 '17 17:12 duncanwp

Sure, this seems like it could make for a nice addition to the docs!

shoyer avatar Dec 18 '17 17:12 shoyer

The current Recipes section might then be better renamed as Gallery?

Yes I agree that "Gallery" should be more a collection of plots than something else. The Parsing rasterio’s geocoordinates is something "in between": the actual message is how to parse the coordinates and would be better placed in a cookbook, while the plot is a nice side product and is well placed in the gallery...

fmaussion avatar Jan 03 '18 13:01 fmaussion

The current Example section is a bit disorganized. Maybe the Cookbook could replace it, and the Gallery could become an independent section?

fmaussion avatar Jan 03 '18 14:01 fmaussion

We will be focusing on this at the SciPy sprint.

rabernat avatar Jul 13 '19 14:07 rabernat

I was wondering if this is still going to be a thing?

I see a branch #1791 but it hasn't been merged. Plus I'm not sure what's the scope of the cookbook.

jejjohnson avatar Oct 25 '19 09:10 jejjohnson

the work done in the scipy sprints is on master now, with plans for new additions in #3564.

keewis avatar Dec 08 '19 23:12 keewis

@keewis Is xarray-tutorial what was imagined with the Cookbook page? Should we close this issue and #1791 as well as #3564?

kmuehlbauer avatar May 23 '25 13:05 kmuehlbauer

not sure. #3564 seems much closer to what https://tutorial.xarray.dev does, while this appears to be more towards a collection of small examples for common tasks (somewhat similar to the itertools recipes).

I'd say #1791 is really old so we should be able to close that.

keewis avatar Jun 01 '25 22:06 keewis