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

Adding Jupyter Book content for v0.4 release #112

Merged
merged 10 commits into from
Sep 7, 2024
Merged

Conversation

asemposki
Copy link
Collaborator

@asemposki asemposki commented Aug 30, 2024

#109 Merging the Jupyter Book pedagogical content, largely based on the JOSS article, to the package for v0.4. This will help users become familiar with the content behind the code, and to know which method to choose for themselves. This will also make the Jupyter Book more useful than just a place for the tutorial notebooks to live. This can be expanded in future releases.

Pending tasks for @asemposki:

  • Reduce output from bilby if possible
  • Full review

Copy link

codecov bot commented Aug 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.60%. Comparing base (49e9fbd) to head (3ae7052).
Report is 69 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #112   +/-   ##
=======================================
  Coverage   66.60%   66.60%           
=======================================
  Files          14       14           
  Lines        1560     1560           
=======================================
  Hits         1039     1039           
  Misses        521      521           

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

@asemposki
Copy link
Collaborator Author

asemposki commented Aug 30, 2024

@jared321 I attempted tox build on my machine, and the Book is failing again in the Trees_BMM_2D notebook, citing a RunTime error. I have not made any changes to that notebook, or pushed anything, so I am unsure of where this is coming from.

@asemposki
Copy link
Collaborator Author

asemposki commented Aug 31, 2024

I also just added the option for Colab to run these notebooks. I remember using it for the BAND camp and I don't like it as much as Codespaces, but Colab is the only one of the two that currently has a direct launch option from the Book, and I am pretty sure that the only way John could get people to run Trees in the Cloud was on Colab. I will include a Codespace introduction in the book though, too, so people know how to navigate there. That will probably just be the instructions on the README of the whole repo.

@asemposki asemposki requested a review from jared321 September 5, 2024 15:40
@asemposki asemposki removed the request for review from jared321 September 7, 2024 21:52
@asemposki
Copy link
Collaborator Author

I will merge this in today, if all checks are passing, as everything looks good and we've both checked it over a few times as we've made progress.

@asemposki asemposki merged commit b025900 into main Sep 7, 2024
32 checks passed
@asemposki asemposki deleted the 109_jupytercontent branch September 7, 2024 22:15
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.

1 participant