StingraySoftware / stingray

Anything can happen in the next half hour (including spectral timing made easy)!
https://stingray.science/stingray
MIT License
166 stars 137 forks source link

Update and reorder tutorials #796

Closed matteobachetti closed 4 months ago

matteobachetti commented 5 months ago

This is an update of the spectral timing tutorial, but also a reorder of the list of tutorials in the main page to give more visibility and centrality to the spectral timing tutorial (that shows off a lot of Stingray's tools, including the new HIDs and power colors). I set up a build on readthedocs to show the new page: https://docs.stingray.science/en/update_docs/ (Compare to https://docs.stingray.science/en/latest/)

Comments welcome.

codecov[bot] commented 5 months ago

Codecov Report

Attention: 6 lines in your changes are missing coverage. Please review.

Comparison is base (72816e0) 96.39% compared to head (bdc25cd) 96.41%.

Files Patch % Lines
stingray/modeling/parameterestimation.py 42.85% 4 Missing :warning:
stingray/power_colors.py 98.82% 2 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #796 +/- ## ========================================== + Coverage 96.39% 96.41% +0.02% ========================================== Files 44 45 +1 Lines 8866 8988 +122 ========================================== + Hits 8546 8666 +120 - Misses 320 322 +2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

matteobachetti commented 4 months ago

Thanks @mgullik, I will work on your comments. A couple of replies:

0) In the tutorial, I read the DET_ID column and renormalize the intensities for the number of detectors that are in during the observation. However, some colleagues pointed out that there are some issues that switch off the detectors during the observation, so the filtering might be better. I don't know what's the cleanest way to handle this, but the procedure is appropriate for the specific case in the tutorial. 1) The fractional rms spectrum is in (rms/mean)^2 Hz^-1, you take out the Hz^-1 factor when you multiply by the frequency. 2) Stingray does the calibration PI/PHA-> energy automatically for a few missions, including NICER (stingray.io.rough_calibration)

matteobachetti commented 4 months ago

Changes to spectral timing notebook: https://github.com/StingraySoftware/notebooks/pull/90

matteobachetti commented 4 months ago

About failing tests: The linkcheck is failing for all stackoverflow links, I asked a question on SO but haven't received an answer yet. The devdeps test seems to fail when importing Astropy, I'm discussing the issue on Slack and will open an issue on Github if needed.

pep8speaks commented 4 months ago

Hello @matteobachetti! 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! :beers:

Comment last updated at 2024-02-21 09:48:44 UTC