-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
duncanwp
wants to merge
3
commits into
pydata:main
Choose a base branch
from
duncanwp:cookbook_docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Cookbook docs #1791
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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')) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
.. _recipes: | ||
.. _gallery: | ||
|
||
Recipes | ||
Gallery | ||
======= | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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: