-
Notifications
You must be signed in to change notification settings - Fork 144
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
Update lombscargle.py #828
Conversation
Hello @hamzaallen! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found: There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻 Comment last updated at 2024-09-11 10:19:02 UTC |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @hamzaallen! A very useful addition to Stingray!
To verify that the code works, it would be good to have one or more tests added to test_lombscargle.py
.
In test_powerspectrum.py
we have a few tests for the equivalent function in Powerspectrum
and AveragedPowerspectrum
, you can use those as templates.
Also, compute_rms
does not have a docstring and we require all user-facing methods to be properly documented
|
||
|
||
|
||
def compute_rms(self, min_freq, max_freq, poisson_noise_level=None): | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add a docstring to the function
Define two functions that calculate the rms and rms error of the spectrum over a specific range of frequencies.
072d4b4
to
6ac6dd5
Compare
Fixes, tests, and docstrings
Define two functions that calculate the rms and rms error of the spectrum over a specific range of frequencies.
Relevant Issue(s)/PR(s)
Provide an overview of the implemented solution or the fix and elaborate on the modifications.
Is there a new dependency introduced by your contribution? If so, please specify.
Any other comments?