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 notebook for NIRCam WFSS Box Extraction #246

Conversation

bhilbert4
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

  • 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.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@bhilbert4
Copy link
Collaborator Author

Waiting on Nor for final approval of the notebook. But otherwise I think we can consider the science review complete, as I looked everything over after Nor gave me the notebook.

@bhilbert4 bhilbert4 changed the title Add notebook for NIRCam WFSS Box Extraction [WIP]: Add notebook for NIRCam WFSS Box Extraction Sep 25, 2024
@bhilbert4
Copy link
Collaborator Author

If I'm interpreting the notes correctly, it looks like the Execution and Validation initially failed on the calls to run_pipeline_steps(). But without detailed notes, it's note clear to me why they failed. Everything works for me locally.

@bhilbert4 bhilbert4 changed the title [WIP]: Add notebook for NIRCam WFSS Box Extraction Add notebook for NIRCam WFSS Box Extraction Oct 1, 2024
@bhilbert4
Copy link
Collaborator Author

@camipacifici this is ready for Technical Review

@camipacifici
Copy link
Contributor

Great! Added to the queue. Any time constraints on the NIRCam side?

@bhilbert4
Copy link
Collaborator Author

No time constraints.

@gibsongreen
Copy link
Collaborator

If I'm interpreting the notes correctly, it looks like the Execution and Validation initially failed on the calls to run_pipeline_steps(). But without detailed notes, it's note clear to me why they failed. Everything works for me locally.

Hi @bhilbert4! For personal or other offsite uses the environment settings for CRDS needs to be manually in order for run_pipeline_steps() to have access to the necessary references files (including the case of the CI). For on-site the default configuration permits CRDS to operate onsite with no explicit environment settings.

Copy link
Collaborator

@gibsongreen gibsongreen left a comment

Choose a reason for hiding this comment

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

The Execution and Validation errors were resolved by adding a cell block that checks to see if the user/CI has their CRDS environment set up, if so continue, and if not, set up the environment so the pipeline has access to references files when necessary. With this, all CI is green.

@gibsongreen gibsongreen merged commit eeea159 into spacetelescope:main Nov 8, 2024
4 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.

3 participants