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

Add CoLab example #18

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

Add CoLab example #18

wants to merge 4 commits into from

Conversation

AleKit
Copy link

@AleKit AleKit commented Oct 3, 2024

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

  • 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
  • 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
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