Skip to content

Add CoLab example #18

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

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

Add CoLab example #18

wants to merge 9 commits into from

Conversation

AleKit
Copy link

@AleKit AleKit commented Oct 3, 2024

Include Kyle's CoLab SWIFTGalaxy demo Jupyter Notebook.
closes #10

AleKit:

  • Add the .ipynb file into the examples/ directory as a"cleanly run" copy
  • Link at the top of the notebook to the interactive version on CoLab
  • Revise notebook content - is anything out of date?
  • Fix warning(s) in notebook run.
  • Make sure colab version and github version agree (can you think of any way to automate verifying this? would be useful to enforce in the test suite... downloading the colab version from the command line and running a diff would be possible, if you can find a way to do the download?)

kyleaoman:

  • Add a README.rst file to the examples/ directory
  • Direct users to the example directory in general (it's newly added) and to this basic example specifically in a few places: the main README.rst of the repository, and maybe one or two places in the docs hosted on RTD (think about suitable location(s))
  • Add automated testing of this notebook to the github checks with the nbmake package. Add nbmake to the optional_requirements.txt file

@kyleaoman kyleaoman added the documentation Improvements or additions to documentation label Oct 5, 2024
@kyleaoman kyleaoman self-requested a review May 29, 2025 13:10
Copy link

codecov bot commented May 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.88%. Comparing base (67cdb91) to head (129a5f2).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #18   +/-   ##
=======================================
  Coverage   92.88%   92.88%           
=======================================
  Files           6        6           
  Lines        1138     1138           
  Branches      203      203           
=======================================
  Hits         1057     1057           
  Misses         45       45           
  Partials       36       36           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@kyleaoman
Copy link
Member

kyleaoman commented May 29, 2025

@AleKit it seems that you'd already done the items on your checklist months ago! I added a couple of other things that perhaps you could take care of?

I also merged in the latest changes from the main branch. and started on my part of the checklist a bit...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Connect with CoLab example
2 participants