Skip to content

Conversation

@DavidT3
Copy link
Collaborator

@DavidT3 DavidT3 commented Oct 22, 2025

HEASARC notebook review

Didn't seem to make sense having another notebook for the machine learning aspect, like there was in the SciServer cookbooks, as a big chunk of it was replicated (the acquisition of the spectra etc.)

So in ingesting that notebook I have added it as a section to the existing RXTE spectral analysis notebook - the combination lets us do some interesting things looking at how model-independent classification compares with fitted model parameters as well.

Re-written the code, and added a lot more commentary.

Critical review criteria

The author of the pull request should make an effort to go through these check points and ensure that their submission satisfies each point - reviewers will also compare to these checklists.

Science review checklist

  • Does using high-energy data make up a significant part of the tutorial?
  • Is there a use case in the introduction that motivates the code?
  • Does the code do what the introduction says it is going to do?
  • Is it scientifically accurate?
  • Have all necessary references to literature been included?

Formatting checklist

  • Did you base your notebook on the HEASARC-tutorials template?
  • Are all sections in the HEASARC-tutorial template included in your notebook?
  • Is the notebook title compact and informative? It will be the name of the notebook on the HEASARC website!
  • Have you populated the notebook front-matter (the metadata at the top of the notebook)?
  • Is the kernel specified in the front-matter (e.g., heasoft, sas, ciao) correct for the notebook?
  • Have you added an entry for your notebook in the *_index.md file for the containing directory?

Tech review checklist

  • Documentation:
    • Is every function documented?
    • Do all code cells have corresponding narratives/comments?
    • Are all code comments of a purely technical nature? All narratives should be in Markdown cells.
    • Did you populate the 'Runtime' section?
  • Notebook execution, error handling, etc.:
    • Does the notebook run end-to-end, out of the box?
    • Are errors handled appropriately, with try/except statements that are narrow in scope?
    • Have warnings been dealt with appropriately, preferably by updating the code to avoid them (i.e., not by simply silencing them)?
  • Efficiency:
    • Is data accessed from the cloud where possible?
    • Is the code parallelized where possible?
    • If the notebook is intended to be scaled up, does it do that efficiently?
    • Is memory usage optimized where possible?
  • Cleanup:
    • Have blocks of code that need to be re-used been turned into functions and placed in the 'global setup'-'function' section?
    • Has unused code been removed (e.g., unused functions and commented-out lines)?
    • Are comment lines wrapped so all fit within a max of 90 - 100 characters per line?
    • Do plots use color-blind friendly palettes for plotting? Try this simulator for a visual check.

…code back in to the notebook in the ML sections. It is compatible with how information is already loaded in, and includes some optimizations/improvements. Still no commentary, and the plotting code will be improved more. For issue #111
…ly on the mean cluster spectra section. For issue #111
…nd changes to Xamin must have kicked in I suppose! Puts issue #111 into PR
@DavidT3 DavidT3 requested a review from zoghbi-a November 6, 2025 20:22
@DavidT3 DavidT3 added skip-doc-build Do not trigger automatic CI/CD building of documentation for this PR. and removed skip-doc-build Do not trigger automatic CI/CD building of documentation for this PR. labels Nov 6, 2025
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.

Add the machine-learning exploration from Tess' RXTE spectrum ML notebook into the RXTE notebook I've already converted

2 participants