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

Fix and deploy dormant DrizzlePac notebook "use_ds9_regions_in_tweakreg.ipynb" #126

Merged
merged 13 commits into from
Jan 18, 2024

Conversation

dulude
Copy link
Collaborator

@dulude dulude commented Nov 9, 2023

Relevant Ticket

High-Level Summary

  • For an unknown reason, the use_ds9_regions_in_tweakreg.ipynb was added to the hst_notebooks repository but explicitly excluded from being deployed. This PR fixes that issue.

Summary of Changes

  • _config.yml: removed notebook "use_ds9_regions_in_tweakreg.ipynb" from "exclude patterns" list
  • use_ds9_regions_in_tweakreg.ipynb: added single space in first markdown cell so that CI/CD tests would trigger.

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.

@dulude dulude added the DrizzlePac DrizzlePac! label Nov 9, 2023
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@dulude dulude changed the title Deploy dormant DrizzlePac notebok "use_ds9_regions_in_tweakreg.ipynb" Fix and deploy dormant DrizzlePac notebok "use_ds9_regions_in_tweakreg.ipynb" Nov 9, 2023
@dulude dulude changed the title Fix and deploy dormant DrizzlePac notebok "use_ds9_regions_in_tweakreg.ipynb" Fix and deploy dormant DrizzlePac notebook "use_ds9_regions_in_tweakreg.ipynb" Nov 9, 2023
@dulude dulude assigned FDauphin and unassigned bjkuhn Nov 9, 2023
FDauphin and others added 2 commits November 10, 2023 16:34
…n_tweakreg_nb

# Conflicts:
#	notebooks/DrizzlePac/use_ds9_regions_in_tweakreg/use_ds9_regions_in_tweakreg.ipynb
#	notebooks/WFC3/persistence/wfc3_ir_persistence.ipynb
@FDauphin
Copy link
Contributor

@camipacifici @haticekaratay @dulude All checks have been passed and are ready for your review 👍🏾

Copy link

review-notebook-app bot commented Dec 21, 2023

View / edit / reply to this conversation on ReviewNB

haticekaratay commented on 2023-12-21T14:30:21Z
----------------------------------------------------------------

A link to initialization notebook can be added for an easy navigation [initialization.ipynb](https://github.com/spacetelescope/hst_notebooks/tree/main/notebooks/DrizzlePac/Initialization)


Copy link

review-notebook-app bot commented Dec 21, 2023

View / edit / reply to this conversation on ReviewNB

haticekaratay commented on 2023-12-21T14:30:21Z
----------------------------------------------------------------

The current link to the TweakReg documentation leads to a "Page Not Found" error. The prior example link seems to be either incorrect or outdated. Similiarly the link provided for the DrizzlePac webpage is also not functioning correctly, as it does not lead to the relevant page


Copy link

review-notebook-app bot commented Dec 21, 2023

View / edit / reply to this conversation on ReviewNB

haticekaratay commented on 2023-12-21T14:30:22Z
----------------------------------------------------------------

Blue apertures are not visible on the plot.


@haticekaratay
Copy link
Collaborator

@FDauphin ,
Thank you for your work on the notebook. I've left some comments for minor improvements. The workflow and descriptions are clear and well-organized. Please remember to clear all output cells.

@FDauphin
Copy link
Contributor

@FDauphin , Thank you for your work on the notebook. I've left some comments for minor improvements. The workflow and descriptions are clear and well-organized. Please remember to clear all output cells.

@haticekaratay Thanks for looking at this and apologies for the delay. I can't see the comments that were made. Should I just push the notebook with empty cells?

@haticekaratay
Copy link
Collaborator

@FDauphin , Thank you for your work on the notebook. I've left some comments for minor improvements. The workflow and descriptions are clear and well-organized. Please remember to clear all output cells.

@haticekaratay Thanks for looking at this and apologies for the delay. I can't see the comments that were made. Should I just push the notebook with empty cells?

You can access the comments that were left on the ReviewNB from this
link or navigating up to the top of the conversation by clicking on the purple button.
image One way to clear output cells is to select Edit from the top navigation bar on your notebook, and then choose Clear Output of All Cells. Finally, save and commit your notebook.

image

@FDauphin
Copy link
Contributor

@haticekaratay Also are the WFC3 IR persistence commits going to overwrite #109? If so, how can we prevent that here?

@FDauphin
Copy link
Contributor

FDauphin commented Jan 17, 2024

@haticekaratay All comments have been addressed and all checks have been passed 👍🏾

@haticekaratay
Copy link
Collaborator

I will revert changes made to the ir_persistence notebook and sync it with the main, as many merge commits are making it challenging to rebase, especially with notebooks.

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.

Thanks for your work. All looks good now.

@haticekaratay haticekaratay merged commit 3ba0d43 into main Jan 18, 2024
6 checks passed
@haticekaratay haticekaratay deleted the deploy_use_ds9_regions_in_tweakreg_nb branch January 18, 2024 04:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DrizzlePac DrizzlePac!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants