Raise error for non-dimensional coordinates

xgcm / xrft

Fourier transforms on xarray data structures

https://xrft.readthedocs.io/en/latest/

MIT License

153 stars 44 forks source link

Raise error for non-dimensional coordinates #163

Closed paigem closed 3 years ago

paigem commented 3 years ago

This PR has two additions (see issue #162):

raises an error in xrft.fft() when there are multiple coordinates attached to the same dimensions (added in xrft.py)
tests for the above error (added to test_xrft.py)

Note that I haven't contributed code for awhile, so a thorough read-through of what I've done would be great. Also, I have never used 'code-style' before, but I got a message stating that "all jobs have failed" and I'm not quite sure how to address this. So let me know if I need to update something here!

roxyboy commented 3 years ago

Thanks for the PR! For the code-style, you need to run black xrft.py and black test_xrft.py. It's a formatting "protocol" of the code... If you don't have black installed, you can do so with pip :)

paigem commented 3 years ago

This PR is ready to be reviewed again @rabernat @roxyboy. Updates since @rabernat's suggested changes above:

I ran the code-style checks using black (thanks @roxyboy!)
Added very minor wording update to @rabernat's second suggested change
I corrected one of @rabernat's suggested changes (changed two instances from dim to d)

Thanks!

roxyboy commented 3 years ago

Thanks @paigem, the reviews all seem resolved so I'll go ahead and merge this.