pydata / pydata/xarray

Poor error message on Dataset.sum(axis=...)

Open
#3,461 10 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

topic-error reporting
Dominant language
Python
Stars
4.2k
Forks
1.4k
Avg merge
2d 15h
Merged PRs (30d)
14

Description

ll_means.nc.gz

MCVE Code Sample

I'm attaching the relevant .nc file.

foo = xr.open_dataset('ll_means.nc')
print(foo)
foo.sum(axis=1) # or foo.sum(axis=0)

Instead of getting a sum (either across the data variables or across the dimension shared between the variables), I get the error in the title: ValueError: cannot supply both 'axis' and 'dim' arguments even though I did not supply a dim argument. Furthermore, I get this error even when passing dim=None.

It's possible that I am doing something wrong, and it is just the error message that is bad, and not the behavior. I don't know enough to tell.

Expected Output

TBQH, I didn't know whether this would sum across the (single) dimension of this dataset, or if it would sum across the data variables along that dimension. I was experimenting to try to figure this out.

What I am trying to do is sum across the data variables, "perpendicular" to a dimension, instead of along it.

Problem Description

I assumed that summing across one of the axes would sum across the data variables, but perhaps that was a bad assumption. At any rate, the current behavior is undesirable.

Output of xr.show_versions()
INSTALLED VERSIONS ------------------ commit: None python: 3.7.4 (default, Jul 9 2019, 18:13:23) [Clang 10.0.1 (clang-1001.0.46.4)] python-bits: 64 OS: Darwin OS-release: 18.7.0 machine: x86_64 processor: i386 byteorder: little LC_ALL: None LANG: en_US.UTF-8 LOCALE: en_US.UTF-8 libhdf5: 1.10.2 libnetcdf: 4.6.3

xarray: 0.12.3
pandas: 0.25.1
numpy: 1.17.1
scipy: 1.3.1
netCDF4: 1.5.2
pydap: None
h5netcdf: None
h5py: 2.9.0
Nio: None
zarr: None
cftime: 1.0.3.4
nc_time_axis: None
PseudoNetCDF: None
rasterio: None
cfgrib: None
iris: None
bottleneck: None
dask: None
distributed: None
matplotlib: 3.1.1
cartopy: None
seaborn: 0.9.0
numbagg: None
setuptools: 41.2.0
pip: 19.3.1
conda: None
pytest: None
IPython: 7.8.0
sphinx: None

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

Start with the MCVE entry point, Dataset.sum(axis=...), using the attached ll_means.nc file and the reported axis=0, axis=1, and dim=None calls. Determine whether the issue is the operation or only the error message; done means the requested behavior is defined and the resulting error or sum is consistent with that definition.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.