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

Edit COS Extract.ipynb to execute with workflow #206

Merged
merged 12 commits into from
Oct 11, 2024
Merged

Conversation

srosagomez
Copy link
Contributor

Edited the variable names in COS Extract.ipynb since they were causing a false positive from the workflow.

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

@haticekaratay
Copy link
Collaborator

@srosagomez, any updates on this notebook?

@haticekaratay
Copy link
Collaborator

@dulude, I wanted to inform you that the execution step is passing even though it should fail as there is an internal failure.

Thanks. I put in ticket SPB-1881 to chase down the issue.
@dulude, we have this PR open because it has been failing since the day it was opened, both in the main and in this branch. Can you help us clarify what the issue is? We haven't received a response with a fix. I see that the ticket is closed, but there has been no communication regarding the fix to be made to us. Thanks

@haticekaratay
Copy link
Collaborator

Hi @dulude,
@annapayne will be working with us going forward on the COS notebooks.

@dulude
Copy link
Collaborator

dulude commented Sep 18, 2024

Hi @dulude, @annapayne will be working with us going forward on the COS notebooks.

@haticekaratay, I added @annapayne.

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.

This notebook requires regular updates with the latest crds files. We should consider finding ways to automate the retrieval of reference files instead of updating manually each time.

@haticekaratay haticekaratay merged commit 1a2cd30 into main Oct 11, 2024
5 checks passed
@haticekaratay haticekaratay deleted the fix-cos-extract-nb branch October 11, 2024 03:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
COS Cosmic Origins Spectrograph
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants