Skip to content

Conversation

@DavidT3
Copy link
Collaborator

@DavidT3 DavidT3 commented Dec 11, 2025

HEASARC notebook review template

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.

…he template, as well as the necessary index entries. For issue #128
…ef introduction to the xtdpipeline, and a note about the relatively immature nature of XRISM's software and best practises. For issue #128
…the call to it, and the setting up of template file paths. For issue #128
…the getting-started-xrism-xtend.md notebook. For issue #128
…dpipeline in the getting-started-xrism-xtend.md. For issue #128
…ting-started-xrism-xtend.md. Also put in subsection heading for the 'generating new products' part. For issue #128
… gets angry if the outdir already exists, and I like to make sure my demos move INTO the out directory to work. As such there is a lower layer temporary outdir created which is where xtdpipeline can write files. All in getting-started-xrism-xtend.md. For issue #128
…y, as well as a demonstration of how to validate our assumed relation through looking at a pre-generated RMF. All in getting-started-xrism-xtend.md, for issue #128
… required for generating energy bound data products for XRISM-Xtend to the getting-started-xrism-xtend.md notebook. For issue #128
…nd images (gen_xrism_xtend_image) to the getting-started-xrism-xtend.md notebook. For issue #128
…-xtend.md notebook, and included some commentary. May add a bit about how to use an event list to find the size of the event pixels. For issue #128
…eration to the getting-started-xrism-xtend.md. For issue #128
…ion in the getting-started-xrism-xtend.md notebook. Seems to work fine, including spatial re-binning and creating different types of map. For issue #128
…tting-started-xrism-xtend.md notebook. For issue #128
…on to the getting-started-xrism-xtend.md notebook, for issue #128
…unction in the getting-started-xrism-xtend.md notebook. For issue #128
…tcurve, to control which light curve bins are thrown out because of fractional exposure. For issue #128
…second section of product generation (with spectra, as it will be source specific). Added a template variable for light curve outputs. All in getting-started-xrism-xtend.md, for issue #128
…getting-started-xrism-xtend.md notebook. Also indicated that N132D can be treated as a point source here, and extended source analysis will be handled in another notebook. For issue #128
…gion file to getting-started-xrism-xtend.md. For issue #128
…es source and background RA-DEC region files. They will be converted to sky coords for each observation, and possibly overlaid on every image from each observation. For issue #128
…ghtcurve' wrapper function for XRISM-Xtend light curve generation in the getting-started-xrism-xtend.md notebook. For issue #128
…ges from XRISM-Xtend data in the getting-started-xrism-xtend.md notebook. If those arguments are missing it seems that no sky-pixel WCS is written to the resulting images, which is obviously a problem. For issue #128
…arted-xrism-xtend.md notebook. Implemented for the light curve generation step at the moment. For issue #128
… getting-started-xrism-xtend.md notebook. For issue #128
…getting-started-xrism-xtend.md notebook. For issue #128.
… generates new spectra which calculates correct values of BACKSCAL for the source and background spectra. For issue #128
@DavidT3
Copy link
Collaborator Author

DavidT3 commented Dec 16, 2025

@heasarc-notebooks:mission_specific_tutorials/xrism/getting-started-xrism-xtend.md

@DavidT3 DavidT3 removed the skip-doc-build Do not trigger automatic CI/CD building of documentation for this PR. label Dec 16, 2025
…er a CircleCI run. In getting-started-xrism-xtend.md. For PR #150
@DavidT3 DavidT3 added the skip-doc-build Do not trigger automatic CI/CD building of documentation for this PR. label Dec 16, 2025
@DavidT3 DavidT3 removed the skip-doc-build Do not trigger automatic CI/CD building of documentation for this PR. label Dec 16, 2025
@DavidT3
Copy link
Collaborator Author

DavidT3 commented Dec 16, 2025

@heasarc-notebooks:mission_specific_analyses/xrism/getting-started-xrism-xtend.md

@DavidT3
Copy link
Collaborator Author

DavidT3 commented Dec 16, 2025

Image with regions overlaid is not accessible for people who are fully color blind - need to fix that.

…addHEASoft6.36 image, so we can test the XRISM Xtend notebook using that version and hopefully have the ARF generation work properly. For PR #150
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc-content Changes or additions to the content of the documentation mission-specific Issues that relate to a single high-energy mission ready-for-review HEASARC internal review process can begin waiting-on-external For an issue that may not be solvable until some external software or resource is fixed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Getting started with XRISM-XTEND tutorial notebook

2 participants