Add NIRISS WFSS Notebook Examples

[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

• [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).
• [x] 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 (hopefully)] 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

for review; I would like comments on this

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

[Rplesha]

This is being reviewed by members of the NIRISS team and @camipacifici before it will be ready to be merged.

[camipacifici]

I talked to the CI folks and got the confirmation that each notebook runs individually, so notebook 01 cannot use the output of notebook 00. Same deal for notebook 02. Can you please store on box the outputs of notebook 00 and 01 so that notebooks 01 and 02 can grab them? I sent you an invite to the box folder. Feel free to create a new folder for this set.

[Rplesha]

I've added the data files to the box folder niriss_wfss_advanced, and then they are separated in there by notebook. The notebooks expect the data in a specific directory though, not necessarily just the top level directory. Does the box folder need to match that structure to work properly?

[camipacifici]

I've added the data files to the box folder niriss_wfss_advanced, and then they are separated in there by notebook. The notebooks expect the data in a specific directory though, not necessarily just the top level directory. Does the box folder need to match that structure to work properly?

Hum...I think you have to use whatever makes sense when you download in the individual notebook. Each notebook should only pull the data it needs, not everything. Maybe I am not understanding the question, sorry.

[Rplesha]

I've added the data files to the box folder niriss_wfss_advanced, and then they are separated in there by notebook. The notebooks expect the data in a specific directory though, not necessarily just the top level directory. Does the box folder need to match that structure to work properly?

Hum...I think you have to use whatever makes sense when you download in the individual notebook. Each notebook should only pull the data it needs, not everything. Maybe I am not understanding the question, sorry.

@camipacifici Right now all of the data are in a single directory for each notebook. However, to run the cells, the notebooks expect that data to be in certain folders, which they're not on box. Do I need to mimic the folder structure that the notebooks expect, or is it fine that the data are just in a single level folder?

[camipacifici]

@Rplesha either you recreate the expected structure on box, or you rearrange the files as they need to be after you download them from the notebook. the important thing is to keep the notebooks independent (they can run without having run the one before) and light (so download only the files the notebook needs). thanks!!

[mgough-970]

Sorry about the spam, I had to update the workflow a bit.
Additionally, all notebooks require a requirements file, these notebooks will fail until one is provided in the notebooks directory.

[Rplesha]

Thanks @mgough-970 ! I was actually just working to make a requirements file now.

[camipacifici]

Thank you for all the edits, @Rplesha!! Whenever you are ready, just put it out of draft and we'll have it go through technical review.

[Rplesha]

@camipacifici this is ready for review now whenever there is time

[camipacifici]

This is great! Thank you!