WFSS 1.20.0 update to work with the latest format of the files. To be deprecated soon

[Rplesha]

This notebook checklist has been made available to us by the 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]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[Rplesha]

Putting this out for the NIRISS team to review first.

We plan to deprecate these notebooks in favor of the jwst-pipeline-notebooks, but we first need to pull out some specific examples that are not shown in those.

Talking with @bhilbert4 we still need to add a banner, too, so more changes to come still.

[Rplesha]

@bhilbert4 the NIRISS team is happy with these changes, so it's ready for any other review that's needed

[bhilbert4]

Ok thanks. Once the failing tests are fixed (looks like maybe it's not finding the data files?) what do you think a reasonable timeline would be between deprecation and removal? 6 months?

I think I remember at one point Cami mentioned that deprecation banners are added via an Action rather than manually. @mgough-970 is that true, or am I making things up?

[Rplesha]

@bhilbert4 I actually don't think the error is on the notebook side or because it can't find the files. If I run the notebook completely independently with the data deleted locally, it runs through fine. I think the error is actually because there's not enough disk space to do the tests (if you look up towards the beginning of the errors)

[bhilbert4]

Ah ok. I thought the two errors were unrelated. This seems like something the CI experts will need to look at then.