Plotting examples #7
Merged
Conversation
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
Adjust dependency structure. Add a custom plotting example (notebook). Update the README.
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
This PR adds Jupyter notebook plotting examples to the repository and addresses issue #5. The changes include dependency reorganization, documentation improvements, and infrastructure updates to support interactive examples.
Key Changes:
- Introduces optional dependencies group for examples (jupyter, ipywidgets, tqdm)
- Moves tqdm from dev dependencies to examples optional dependencies
- Updates documentation with improved installation instructions and usage examples
- Adds Jupyter notebook checkpoint exclusions to .gitignore
Reviewed changes
Copilot reviewed 3 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Version bump to 0.2.2, adds optional dependencies for examples, reorganizes tqdm placement |
| README.md | Enhanced documentation with clearer installation steps, usage examples, and updated visualization showcases |
| examples/README.md | Adds reference to new jupyter directory with plotting customization examples |
| .gitignore | Adds Jupyter notebook checkpoint exclusions |
| uv.lock | Updates dependency lock file with jupyter ecosystem packages and their transitive dependencies |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
wwang721
added a commit
that referenced
this pull request
Jan 2, 2026
Plotting examples and close #5
wwang721
added a commit
that referenced
this pull request
Jan 6, 2026
Plotting examples and close #5
wwang721
added a commit
that referenced
this pull request
Jan 12, 2026
Plotting examples and close #5
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.
Close #5