NIRISS SOSS calibrating TSO products and light curve generating

[tbainesUA]

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

[tbainesUA]

I've gone through my notebook and attempted to correct them where some tests were failing. I've fixed the PEP8 standard issues. However, I am unsure about the Notebook execution steps. For the second notebook 02_niriss_soss_spec2_generate_lightcurves, it uses the saved output results that are produced from the first notebook 01_niriss_soss_detector1_reduction.

In regard to environment setup to run notebook I had to modify the existing requirement.txt for the tests to run. I addition I've provided a soss specific requirements as well if it needed at all.

[gibsongreen]

I've gone through my notebook and attempted to correct them where some tests were failing. I've fixed the PEP8 standard issues. However, I am unsure about the Notebook execution steps. For the second notebook 02_niriss_soss_spec2_generate_lightcurves, it uses the saved output results that are produced from the first notebook 01_niriss_soss_detector1_reduction.

In regard to environment setup to run notebook I had to modify the existing requirement.txt for the tests to run. I addition I've provided a soss specific requirements as well if it needed at all.

Hello Tyler,

After running through the two notebooks, there are an only a few technical changes necessary to pass CI.

The main change that we will have to make to the notebooks is storing the generated data from the first notebook into a Box directory, and adding some code so this Box directory and the generated data is accessible to the second notebook.

For some background, the CI does not look at the PR in totality, but rather, it runs the notebooks separately. Thus, the second notebook will not have access to the data generated by the first notebook. By adding a Box directory, this will ensure that both notebooks can be run individually (by both a user and the CI).

[gibsongreen]

A quick update:
We had our biweekly CI meeting this afternoon and came to a resolution for this notebook and how to implement PRs with multiple notebooks that need to be run in order for any future PR's.

For this notebook, I will work to add the Box link with the generated data for the first notebook. There will be an additional comment added at this section explaining the reasoning behind the code block that will enable to second notebook to pass CI with said Box link. This will be a temporary solution while the CI team works on the solution to enable specific notebooks to run in order.

Once this is implemented and tested by the CI team, we will create a second PR for this notebook, striping the extract code block and comment that allowed the CI to originally pass CI.

[drlaw1558]

Just adding a quick note that the jwst-pipeline-notebooks are intended to be rather different from the previous JDAT notebooks, and should not in general split a given observing mode between two different notebooks. As such, there should be no need for notebooks to run in order. It would be best to pause further testing here until we've got a template notebook finalized and can discuss content and overall design prior to digging into more technical details.

[gibsongreen]

Hey @drlaw1558! I wanted to follow up more in general about this repository. I was wondering if there are any status updates on the development of the template notebook and the subsequent content of notebooks within the repository as discussed in your previous comment.

[drlaw1558]

@gibsongreen Thanks for the reminder. The template notebooks have now evolved considerably, with both a MIRI MRS and NIRISS imaging notebook in the repo and MIRI imager and NIRCam image notebooks following this structure under review (PR 23 and 19). We are not planning on merging this notebook (PR 6) at the present time as it doesn't conform to the template structure. That said, it may be helpful to the NIRISS team to keep the PR around for the time being until there is a SOSS notebook submitted that does follow the template.

[gibsongreen]

@gibsongreen Thanks for the reminder. The template notebooks have now evolved considerably, with both a MIRI MRS and NIRISS imaging notebook in the repo and MIRI imager and NIRCam image notebooks following this structure under review (PR 23 and 19). We are not planning on merging this notebook (PR 6) at the present time as it doesn't conform to the template structure. That said, it may be helpful to the NIRISS team to keep the PR around for the time being until there is a SOSS notebook submitted that does follow the template.

Thank you for the update, I'll inform the other stakeholders as well! I noticed a similar comment here #7 (comment) regarding holding off on merging due to the template structure. Is this also the case for that PR?

[drlaw1558]

That's right; I know that NIRSpec is working on a notebook in the new form, but I don't know whether they intend to replace the notebook in PR #7 or open a new PR.