Deprecating `dft` and replacing it with `fft`

xgcm / xrft

Fourier transforms on xarray data structures

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

MIT License

153 stars 45 forks source link

Deprecating `dft` and replacing it with `fft` #161

Closed roxyboy closed 3 years ago

roxyboy commented 3 years ago

A PR to initiate a deprecation cycle for xrft.dft and to replace it with xrft.fft. As the tests all pass using dft, none of the previous behaviors should break with only the warning messages changing.

roxyboy commented 3 years ago

@santisoler @lanougue Do you have any input on this? Follow our discussion in #154, I tried unifying xrft to fft.

roxyboy commented 3 years ago

@rabernat This deprecation cycle of removing dft and unifying the default function to fft will result in quite a drastic change down the line but would you agree with this? It seems that having two functions (fft and dft) is confusing to users.