Add HASP Wavelength Adjustment notebook

[srosagomez]

A notebook to guide users on shifting COS and STIS data that have wavelength offsets. Goes through identifying if there is an offset using the coadd, determining the offset in pixels, running the respective calibration pipelines, re-running coadd, and comparing the pre- and post- shifted coadds.

This notebook checklist has been made available to us by the Notebooks For All team. Its purpose is to serve as a guide for both the notebook author and the technical reviewer highlighting critical aspects to consider when striving to develop an accessible and effective notebook.

The First Cell

• [ ] The title of the notebook in a first-level heading (eg. <h1> or # in markdown).
• [ ] A brief description of the notebook.
• [ ] A table of contents in an ordered list (1., 2., etc. in Markdown).
• [ ] The author(s) and affiliation(s) (if relevant).
• [ ] The date first published.
• [ ] The date last edited (if relevant).
• [ ] A link to the notebook's source(s) (if relevant).

The Rest of the Cells

• [ ] There is only one H1 (# in Markdown) used in the notebook.
• [ ] The notebook uses other heading tags in order (meaning it does not skip numbers).

Text

• [ ] All link text is descriptive. It tells users where they will be taken if they open the link.
• [ ] All acronyms are defined at least the first time they are used.
• [ ] Field-specific/specialized terms are used when needed, but not excessively.

Code

• [ ] Code sections are introduced and explained before they appear in the notebook. This can be fulfilled with a heading in a prior Markdown cell, a sentence preceding it, or a code comment in the code section.
• [ ] Code has explanatory comments (if relevant). This is most important for long sections of code.
• [ ] If the author has control over the syntax highlighting theme in the notebook, that theme has enough color contrast to be legible.
• [ ] Code and code explanations focus on one task at a time. Unless comparison is the point of the notebook, only one method for completing the task is described at a time.

Images

• [ ] All images (jpg, png, svgs) have an image description. This could be

  • [ ] Alt text (an alt property)
  • [ ] Empty alt text for decorative images/images meant to be skipped (an alt attribute with no value)
  • [ ] Captions
  • [ ] If no other options will work, the image is decribed in surrounding paragraphs.

• [ ] Any text present in images exists in a text form outside of the image (this can be alt text, captions, or surrounding text.)

Visualizations

• [ ] All visualizations have an image description. Review the previous section, Images, for more information on how to add it.

• [ ] Visualization descriptions include

  • [ ] The type of visualization (like bar chart, scatter plot, etc.)
  • [ ] Title
  • [ ] Axis labels and range
  • [ ] Key or legend
  • [ ] An explanation of the visualization's significance to the notebook (like the trend, an outlier in the data, what the author learned from it, etc.)

• [ ] All visualizations and their parts have enough color contrast (color contrast checker) to be legible. Remember that transparent colors have lower contrast than their opaque versions.

• [ ] All visualizations convey information with more visual cues than color coding. Use text labels, patterns, or icons alongside color to achieve this.

• [ ] All visualizations have an additional way for notebook readers to access the information. Linking to the original data, including a table of the data in the same notebook, or sonifying the plot are all options.

[review-notebook-app[bot]]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[sosey]

There are a couple errors here to deal with I think? I think the first one to tackle is getting the reference files downloaded to the runner, which errors before the hstcal issue.

• The notebook assumes the user already has them, but in the case that the CI is the user, they still need to be downloaded, and hstcal doesn't do this automatically like jwst. This can be scripted in advance for hst using crds sync
  • see: https://github.com/spacetelescope/hst_notebooks/actions/runs/9914031141/job/27392331782?pr=297#step:6:62
  • I get the same error locally when I haven't preset my CRDS cache, downloading fixes this part of the notebook

[haticekaratay]

The notebook is looking good so far! I noticed you started off using Path for handling file paths, which is great. To keep everything streamlined, I’d suggest using pathlib across the whole notebook to keep the code clean and consistent. I thought about recommending some helper functions for the plots to tidy things up, but since this is a tutorial, it might be clearer to keep things more explicit for now.

Also, it might be helpful to split this notebook into two separate ones—one for COS and one for STIS. This notebook is getting quite lengthy, and since both sections follow similar workflows, splitting them could make each one more focused and easier to manage. Just a thought!

[haticekaratay]

One thing to note—I wasn't able to run checks for spelling or subtle errors like I could in a more robust code editor due to the limitations of the Review NB. Run them first in your notebook to test them out.

[haticekaratay]

I noticed two deprecation warnings that need addressing.

UserWarning: GFIT is deprecated - stsci.tools v 3.4.12 is the last version to contain it.Use astropy.modeling instead.
  warnings.warn("GFIT is deprecated - stsci.tools v 3.4.12 is the last version to contain it."
UserWarning: NMPFIT is deprecated - stsci.tools v 3.5 is the last version to contain it.
  warnings.warn("NMPFIT is deprecated - stsci.tools v 3.5 is the last version to contain it.")

Since this is a new notebook, it’s essential to update the methods to the latest standards.

[haticekaratay]

Hi @srosagomez, The notebook is taking more than 30 minutes to run and is pulling a large data set, which is causing the runners to fail due to insufficient space. In these cases, we ask that a subset of data be used in notebooks if possible.