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

added VAP quicklook notebooks, added entry point to _toc.yml, setup _… #100

Merged
merged 2 commits into from
May 10, 2024

Conversation

kefeimo
Copy link
Contributor

@kefeimo kefeimo commented May 2, 2024

Description:

Background: ENG0004668
As discussed in ENG0004668, this PR contains:

  • 200 + quicklook notebooks (associated with each data class), target path: "ARM-Notebooks/VAPs/quicklook"
  • the md file "vap_notebook_list.md" with hyper links to redirect users to jupyter hub to open the notebooks.
    • redirect link pattern: f"{JUPYTERHUB_URL}hub/user-redirect/git-pull?repo={quote(GITHUB_REPO_URL)}&urlpath={ds_nb_path}&branch={github_branch_name}", where
      • JUPYTERHUB_URL = "https://jupyterhub.arm.gov/"
      • GITHUB_REPO_URL = "https://github.com/ARM-Development/ARM-Notebooks"
      • ds_nb_path = quote(f"{jupyterhub_notebook_path}/{k.upper()}/{ds_name}.ipynb"), where jupyterhub_notebook_path = r"lab/tree/ARM-Notebooks/../user-data-home/ARM-Notebooks/VAPs/quicklook" # where the notebooks locate
      • github_branch_name = "main"
  • "_toc.yml" file reflects the the md file "vap_notebook_list.md" location in Jupyter book
  • added exclude_patterns: ["VAPs/quicklook/*"] to "_config.yml" to avoid including 200 plus ipynb files into html build.
  • added _build/ in ".gitignore"

Render result screenshot

image

…config.yml to skip VAP/quicklook/* into build.
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link
Collaborator

@mgrover1 mgrover1 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 the hard work here @kefeimo - let's merge this an iterate 😄

@mgrover1
Copy link
Collaborator

one slight modification, it looks like the notebook checkpoints are in here. I can remove these!

@mgrover1 mgrover1 merged commit ff82789 into ARM-Development:main May 10, 2024
2 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.

2 participants