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

API name (i)qct/(i)qst, easy-to-read help document? #9

Open
zoziha opened this issue Aug 21, 2021 · 0 comments
Open

API name (i)qct/(i)qst, easy-to-read help document? #9

zoziha opened this issue Aug 21, 2021 · 0 comments

Comments

@zoziha
Copy link
Contributor

zoziha commented Aug 21, 2021

Problem 1: The API name (i)qct?

I improved the interfaces and its documentation of dcosq routines in this branch (I may consider submitting a PR tomorrow?). They compute the fast fourier transform of quarter wave data, but I don't know enough about them ("quarter wave data"), this involves more professional terms and I can't even find their corresponding routines in scipy.fftpack.
What should their simplified modern interface be called? qct(Quarter-Cosine Transform)?
(see https://www2.cisl.ucar.edu/resources/legacy/fft5/documentation)
image

Problem 2: more complex document (fftpack.md) that is difficult to read for users?

fftpack.md is getting more complicated and may be difficult to read?
It contains original fftpack routines (dfft/dzfft/...), modern interfaces (fft/rfft/...), and utility functions (fftshift).

Maybe we can divide the existing fftpack.md into three markdown documents: fftpack_classic_API.md, fftpack_modern_API.md, fftpack_utilities.md.

This issue is not urgent, I am just worried.

@zoziha zoziha changed the title API name (i)qct, and complex documents (fftpack.md) that are difficult to read API name (i)qct, and complex document (fftpack.md) that is difficult to read Aug 21, 2021
@zoziha zoziha changed the title API name (i)qct, and complex document (fftpack.md) that is difficult to read API name (i)qct/(i)qst, easy-to-read help document? Aug 31, 2021
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

No branches or pull requests

1 participant