Skip to content

Cookbook docs #1791

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ Examples
examples/weather-data
examples/monthly-means
examples/multidimensional-coords
examples/cookbook
auto_gallery/index
36 changes: 36 additions & 0 deletions doc/examples/cookbook.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.. _examples.cookbook:

Cookbook
========

This is a repository for short and sweet examples and links for useful xarray recipes. We encourage users to add to this documentation.

Adding interesting links and/or inline examples to this section is a great First Pull Request.

Pandas (pd), Numpy (np) and xarray (xr) are the only abbreviated imported modules. The rest are kept explicitly imported for newer users.


.. ipython:: python
:suppress:

import numpy as np
import pandas as pd
import xarray as xr

Example recipe
--------------

Flip array dimension
....................

It's very easy to flip a ``DataArray`` along a named dimension, for example to reverse a decreasing coordinate, by indexing the ``dims`` attribute:

.. ipython:: python

da = xr.DataArray(np.random.rand(4, 5), dims=['x', 'y'],
coords=dict(x=[40, 30, 20, 10],
y=pd.date_range('2000-01-01', periods=5)))

da

np.flip(da, da.dims.index('x'))
Copy link
Collaborator

Choose a reason for hiding this comment

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

The cookbook would be great! Thanks for giving it an initial go.

Unfortunately flip is the one function that is about to be in the library!

Other good starting points might be:

  • Constructing Datasets & DataArrays (I know there's a learning curve 'bump' vs pandas here)
  • Merge & concats
  • Shifting while extending a dimension (?)

4 changes: 2 additions & 2 deletions doc/gallery/README.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. _recipes:
.. _gallery:

Recipes
Gallery
=======