How to cite?

[EliousMondal]

Hello,

I am writing a paper, in which I used your package. How do I cite this in my paper?

Thanks,
Elious

[styfenschaer]

Hi @EliousMondal,

I'm glad to hear that you found the package useful!

Unless your paper specifically focuses on FFT in a way that the use of this particular package is crucial, I don't believe you need to cite it. However, if you do decide to cite it, please be aware that this package is essentially a wrapper around PocketFFT, which performs the actual transformations.

I think making your code public and thus implying its dependencies would be ideal. Some journals also provide guidelines on how to cite software, so it's worth checking those. If you find it necessary to cite this package, you can use the following citation:

@misc{rocket_fft,
  author = {Styfen Schär},
  title = {Rocket-FFT},
  year = {2024},
  version = {0.2.5},
  note = {Available from https://github.com/styfenschaer/rocket-fft/releases/tag/v0.2.5},
}

In any case, I appreciate that you’re taking citations seriously!

Best regards,
Styfen

[EliousMondal]

Thanks a lot. My code is written in python using numba and also FFT is the most important ingredient of my work. So your wrapper is an essential necessity for my current version. Thanks for sharing. I will cite this and PocketFFT also. The code and paper should be available within next few months.

[david-zwicker]

One way to make the package more citable in the future would be to write a short paper in the Journal of Open Source Science, which is a very smooth process. I have quite good experience with it!