Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add NIRISS imaging pipeline tutorial notebook #215

Merged
merged 8 commits into from
Mar 13, 2024

Conversation

gibsongreen
Copy link
Collaborator

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

  • [ X] The title of the notebook in a first-level heading (eg. <h1> or # in markdown).
  • [ X] A brief description of the notebook.
  • [ X] A table of contents in an ordered list (1., 2., etc. in Markdown).
  • The author(s) and affiliation(s) (if relevant).
  • [ X] 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

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

Text

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

Code

  • [X ] 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.
  • [ X] 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.
  • [ X] 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.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@gibsongreen
Copy link
Collaborator Author

@mgough-970 This notebook's Execution/Validation CI is timing out with the 2000 second limit. I reached out to Hatice before this comment and she had let me know it's been a known issue and suggested I reach out to you to see if there have been any updates or work arounds.

Notebook cell execution failed
Cell 6: Timeout of 2000 seconds exceeded executing cell

After this is resolved, I'll make sure to take into account your last comment on #212 and follow a similar path with this PR.

@mgough-970 mgough-970 closed this Mar 8, 2024
@mgough-970 mgough-970 reopened this Mar 8, 2024
@mgough-970 mgough-970 closed this Mar 11, 2024
@mgough-970 mgough-970 reopened this Mar 11, 2024
@mgough-970 mgough-970 closed this Mar 12, 2024
@mgough-970 mgough-970 reopened this Mar 12, 2024
@camipacifici
Copy link
Contributor

Thank you @mgough-970 for fixing this!
@gibsongreen I think this is ready to go in now.

@gibsongreen
Copy link
Collaborator Author

Thank you @mgough-970 for fixing this! @gibsongreen I think this is ready to go in now.

Thank you @mgough-970 !!!

Copy link
Collaborator

@haticekaratay haticekaratay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gilbert, approving it to unblock you from merging it. Thanks for your work!

@gibsongreen gibsongreen merged commit 93bb1f4 into spacetelescope:main Mar 13, 2024
6 checks passed
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.

5 participants