Fix the grid_3d notebook#36
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Sphinx documentation example notebooks and gallery configuration so the rendered docs include the intended notebook set/order, while also reducing Plotly output size and fixing notebook text/docstrings.
Changes:
- Adjusts the examples gallery configuration (removing
:reversed:) and adds/renames multiple documentation notebooks. - Updates Plotly usage in notebooks (e.g., renderer changes in
grid_3d.ipynb) and tweaks notebook visuals. - Minor docstring cleanup in
load_core_plasma()documentation.
Reviewed changes
Copilot reviewed 3 out of 8 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/cherab/imas/plasma/core.py | Docstring cleanup for load_core_plasma() parameter documentation. |
| docs/source/examples.md | Updates notebook gallery directive options/order. |
| docs/notebooks/radiation/radiation_3d.ipynb | Adds a new 3D radiation emitter example notebook. |
| docs/notebooks/radiation/grid_3d.ipynb | Tweaks Plotly rendering/layout to improve doc rendering/output size. |
| docs/notebooks/plasma/1_equilibrium.ipynb | Adds a plasma equilibrium example notebook. |
| docs/notebooks/plasma/2_edge_plasma.ipynb | Adds an edge plasma profiles example notebook. |
| docs/notebooks/plasma/3_full_plasma.ipynb | Adds a full plasma (core+edge) example notebook. |
| docs/notebooks/plasma/4_emission.ipynb | Adds an emission models example notebook. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #36 +/- ##
=======================================
Coverage 69.55% 69.55%
=======================================
Files 52 52
Lines 3291 3291
Branches 526 526
=======================================
Hits 2289 2289
Misses 766 766
Partials 236 236 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Key changes: