Skip to content

[docs] add Dataset.assign_coords example (#6336) #6558

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
May 11, 2022
Merged

[docs] add Dataset.assign_coords example (#6336) #6558

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8434785
[docs] add Dataset.assign_coords example (#6336)
May 2, 2022
3aa2ebb
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 2, 2022
dc533c8
[docs] amend Dataset.assign_coords example (#6336)
May 4, 2022
357f4cc
[docs] amend Dataset.assign_coords example (#6336)
May 4, 2022
5eaa9c6
[docs] amend Dataset.assign_coords example (#6336)
May 4, 2022
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
50 changes: 49 additions & 1 deletion xarray/core/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ def assign_coords(self, coords=None, **coords_kwargs):

Examples
--------
Convert longitude coordinates from 0-359 to -180-179:
Convert `DataArray` longitude coordinates from 0-359 to -180-179:

>>> da = xr.DataArray(
... np.random.rand(4),
Expand Down Expand Up @@ -490,6 +490,54 @@ def assign_coords(self, coords=None, **coords_kwargs):

>>> _ = da.assign_coords({"lon_2": ("lon", lon_2)})

Note the same method applies to `Dataset` objects.

Convert `Dataset` longitude coordinates from 0-359 to -180-179:

>>> temperature = np.linspace(20, 32, num=16).reshape(2, 2, 4)
>>> precipitation = 2 * np.identity(4).reshape(2, 2, 4)
>>> ds = xr.Dataset(
... data_vars=dict(
... temperature=(["x", "y", "time"], temperature),
... precipitation=(["x", "y", "time"], precipitation),
... ),
... coords=dict(
... lon=(["x", "y"], [[260.17, 260.68], [260.21, 260.77]]),
... lat=(["x", "y"], [[42.25, 42.21], [42.63, 42.59]]),
... time=pd.date_range("2014-09-06", periods=4),
... reference_time=pd.Timestamp("2014-09-05"),
... ),
... attrs=dict(description="Weather-related data"),
... )
>>> ds
<xarray.Dataset>
Dimensions: (x: 2, y: 2, time: 4)
Coordinates:
lon (x, y) float64 260.2 260.7 260.2 260.8
lat (x, y) float64 42.25 42.21 42.63 42.59
* time (time) datetime64[ns] 2014-09-06 2014-09-07 ... 2014-09-09
reference_time datetime64[ns] 2014-09-05
Dimensions without coordinates: x, y
Data variables:
temperature (x, y, time) float64 20.0 20.8 21.6 22.4 ... 30.4 31.2 32.0
precipitation (x, y, time) float64 2.0 0.0 0.0 0.0 0.0 ... 0.0 0.0 0.0 2.0
Attributes:
description: Weather-related data
>>> ds.assign_coords(lon=(((ds.lon + 180) % 360) - 180))
<xarray.Dataset>
Dimensions: (x: 2, y: 2, time: 4)
Coordinates:
lon (x, y) float64 -99.83 -99.32 -99.79 -99.23
lat (x, y) float64 42.25 42.21 42.63 42.59
* time (time) datetime64[ns] 2014-09-06 2014-09-07 ... 2014-09-09
reference_time datetime64[ns] 2014-09-05
Dimensions without coordinates: x, y
Data variables:
temperature (x, y, time) float64 20.0 20.8 21.6 22.4 ... 30.4 31.2 32.0
precipitation (x, y, time) float64 2.0 0.0 0.0 0.0 0.0 ... 0.0 0.0 0.0 2.0
Attributes:
description: Weather-related data

Notes
-----
Since ``coords_kwargs`` is a dictionary, the order of your arguments
Expand Down