Skip to content
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.

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

Updates to documentation with xarray tutorial data #151

Merged
merged 11 commits into from
Jul 1, 2021

Conversation

roxyboy
Copy link
Member

@roxyboy roxyboy commented May 20, 2021

A PR to update the documentation and address #147 . I added an example from #144.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@roxyboy
Copy link
Member Author

roxyboy commented May 20, 2021

I think we should make a new release if people are ok with the changes in the documentation.

@roxyboy
Copy link
Member Author

roxyboy commented Jun 10, 2021

@lanougue @rabernat Any thoughts on this PR on making the documentation more helpful? I added an example using the xarray tutorial data.

doc/DFT-iDFT_example.ipynb Show resolved Hide resolved
doc/DFT-iDFT_example.ipynb Show resolved Hide resolved
doc/DFT-iDFT_example.ipynb Show resolved Hide resolved
doc/DFT-iDFT_example.ipynb Show resolved Hide resolved
doc/DFT-iDFT_example.ipynb Show resolved Hide resolved
@lanougue
Copy link
Contributor

Thanks @roxyboy for this work! A personnal global comment on this documentation would be that it seems to prove that numpy.fft could be enough if used carrefully (in combination with apply_ufunc for example).
On the contrary I would promote xrft power arguing that it takes care of phase, amplitude, spacing, number of points, ... automatically. From my point of view, this should also be done by emphasizing the defaults of the numpy.fft instead of trying to show that they can be handled by a careful user.
xrft is not only a very useful wrapper for Fourier Transforms with xarrays, but also correctly takes care of all the scaling and phasing inherent to Fourier Transforms.
Thanks again for the energy you put in xrft! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants