Skip to content

Update ACS dependencies #302

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

Merged
merged 3 commits into from
Aug 29, 2024
Merged

Update ACS dependencies #302

merged 3 commits into from
Aug 29, 2024

Conversation

haticekaratay
Copy link
Collaborator

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 haticekaratay changed the title WIP: Update ACS dependencies Update ACS dependencies Aug 13, 2024
@haticekaratay
Copy link
Collaborator Author

@sosey, I have conducted a local run of all the notebooks and provided @alyssaguzman with a report detailing the ones requiring updates. The notebooks experiencing failures fail on the main branch and are not caused by these dependency updates.

@haticekaratay haticekaratay requested a review from sosey August 13, 2024 15:33
Copy link
Member

@sosey sosey left a comment

Choose a reason for hiding this comment

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

@haticekaratay it looks like the acs_findsat_mrt_example requirements is installing scipy 1.14 from the scikit-image dependency chain, and that's having issues. Did you ask for the interp to be updated? I see the same failure on main for that notebook.

NotImplementedError: interp2d has been removed in SciPy 1.14.0.

@alyssaguzman
Copy link
Collaborator

@sosey @haticekaratay I am in contact with the notebook creator and he's working on updating the code to not use interp2d. I will provide further updates on this.

@haticekaratay
Copy link
Collaborator Author

@haticekaratay it looks like the acs_findsat_mrt_example requirements is installing scipy 1.14 from the scikit-image dependency chain, and that's having issues. Did you ask for the interp to be updated? I see the same failure on main for that notebook.

NotImplementedError: interp2d has been removed in SciPy 1.14.0.

Yes, the POC for these notebooks is @alyssaguzman. And I've been in contact with her regarding the notebooks, she is on it. :)

@haticekaratay haticekaratay requested a review from sosey August 29, 2024 13:57
Copy link
Member

@sosey sosey left a comment

Choose a reason for hiding this comment

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

The changes seem reasonable. For clarity, I think it's fine to accept the notebook before acstools is updated for the change in scipy, though I think I saw a pr just get accepted for that change. @alyssaguzman is on it and can advise on the timeframe.

@haticekaratay haticekaratay merged commit ab2954c into main Aug 29, 2024
14 of 19 checks passed
@haticekaratay haticekaratay deleted the acs-dependencies branch August 29, 2024 17:08
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