pydata / pydata/xarray

Keep index dimension when selecting only a single coord

Open
#3,458 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

contrib-good-first-issue topic-documentation
Dominant language
Python
Stars
4.2k
Forks
1.4k
Avg merge
2d 15h
Merged PRs (30d)
14

Description

MCVE Code Sample
# Your code here
import numpy as np
import xarray as xr

data = np.zeros((10, 4))
example_xr = xr.DataArray(data, coords=[range(10), ["idx0", "idx1", "idx2", "dim3"]], dims=["rows", "cols"])

# desired behavior
subset = example_xr[:, 1:2]
subset.shape

# inclusive indexing means both idx1 and idx2 kept
subset_named1 = example_xr.loc[:, "idx1":"idx2"]
subset_named1.shape

# slicing behavior means that 2nd dimension is dropped
subset_named2 = example_xr.loc[:, "idx1"]
subset_named2.shape
Expected Output

I'd like to be able to use named .loc indexing to select only a single named coord from one dimension, but not have that dimension collapse when subsetting.

Problem Description

I looked, but wasn't able to find anything in the documentation about how to perform this same action using named coords. It works with integer-based slicing.

Output of xr.show_versions()
# Paste the output here xr.show_versions() here

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Run the MCVE with Python, NumPy, and xarray, comparing the shapes of integer slicing and the two named .loc selections. Trace the .loc selection entry point and add regression coverage showing that selecting one named coordinate preserves its dimension, with the expected shape as the completion criterion.

Written by the indexing model from the issue text.

Assessment

Tech stack
numpy, python
Domain
data
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.