Added basic bug hunting documentation#1077
Merged
jacobcook1995 merged 13 commits intofeature/docs-ui-updatefrom Mar 31, 2026
Merged
Added basic bug hunting documentation#1077jacobcook1995 merged 13 commits intofeature/docs-ui-updatefrom
jacobcook1995 merged 13 commits intofeature/docs-ui-updatefrom
Conversation
…ng her UROP project to the docs Co-Authored-By: Lingda Lu <151921362+LingdaLu@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## feature/docs-ui-update #1077 +/- ##
=======================================================
Coverage 94.10% 94.10%
=======================================================
Files 72 72
Lines 7604 7604
=======================================================
Hits 7156 7156
Misses 448 448 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
for more information, see https://pre-commit.ci
…till need to be integrated with the other content
495a4dc to
6892c3e
Compare
…w to give a better overall framing
Collaborator
Author
|
@davidorme I've integrated your debugging notes in here and added an over arching section to link it with Lingda's work. Let me know whether it all looks okay to you, or if there's anything I should change! |
davidorme
approved these changes
Mar 31, 2026
Collaborator
davidorme
left a comment
There was a problem hiding this comment.
LGTM - sorry for the slow 👍
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds simplified versions of the bug hunting/squashing notebooks that @LingdaLu developed as part of her UROP project.
I haven't written much superstructure, and I think we still need to decide the best way to include Jupyter notebooks, so I'm submitting this as a draft.
Feedback on what's being plotted in the notebooks is also very welcome (think I've become sufficiently used to staring at this kind of plot to be basically blind to possible improvements)
I'm also aware that the second notebook is very messy due to the divide by zero warnings, I'm planning to wait until #1006 (which fixes that issue) is merged and then rerun the notebook.
The docs associated with this PR can be found here
Type of change
Key checklist
pre-commitchecks:$ pre-commit run -a$ poetry run pytestFurther checks