Add WFC3 notebook 'TVB_flattenramp_notebook.ipynb'

[dulude]

Relevant Tickets

• SPB-1631

---

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.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[kyhuynh108]

@haticekaratay @camipacifici
Hi, this notebook is ready for review, with a couple of additional comments:

1. I can't seem to fix the pep8 fail i got: the error says it is an indentation error, however that entire cell seems to be formatted correctly. Do you have any ideas on whats causing this fail and what I can do to fix it? I tried to fix it through several different commits without any success. It's also not showing other pep8 fails the notebook may have, but I tried to fix as much as I could manually.
2. The line "...see the IR IMA Visualization Notebook (O'Connor 2023)." in "Learning Goals" is currently linking to the IR IMA visualization notebook directory in the main hst notebook github repository. Should this be linked to the HQ output site version when this notebook is published?

Thanks,
Ky

[FDauphin]

@haticekaratay @camipacifici Hi, this notebook is ready for review, with a couple of additional comments:

1. I can't seem to fix the pep8 fail i got: the error says it is an indentation error, however that entire cell seems to be formatted correctly. Do you have any ideas on whats causing this fail and what I can do to fix it? I tried to fix it through several different commits without any success. It's also not showing other pep8 fails the notebook may have, but I tried to fix as much as I could manually.
2. The line "...see the IR IMA Visualization Notebook (O'Connor 2023)." in "Learning Goals" is currently linking to the IR IMA visualization notebook directory in the main hst notebook github repository. Should this be linked to the HQ output site version when this notebook is published?

Thanks, Ky

Hey @haticekaratay, just a small bump for @kyhuynh108 questions a few weeks ago 👍🏾

[haticekaratay]

Hi @dulude,
I fixed numerous style errors that weren't listed in the logs while trying to replicate the error mentioned by @kyhuynh108. Is it because v4 is being used in the actions? Can you please take a look? Thanks

[haticekaratay]

Hi @dulude, I fixed numerous style errors that weren't listed in the logs while trying to replicate the error mentioned by @kyhuynh108. Is it because v4 is being used in the actions? Can you please take a look? Thanks

This issue has been resolved. Thank you @dulude for updating the CI implementation to check Pep8.

[haticekaratay]

Thank you for your hard work. I made some improvements to the notebook to assist you in the process. Specifically, I :

• Corrected style errors
• Refactored the file paths to improve clarity, and implemented context managers for file manipulation
• Updated the string manipulations to clearer formats