Changes to notebooks and documentation#9
Merged
lmoresi merged 3 commits intodevelopmentfrom Jul 29, 2025
Merged
Conversation
Some rewriting of the internal solver documentation in response to JOSS reviews. Updating notebooks to current codebase (e.g. evalf -> evaluate with rbf argument). Improving adaptivity example
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR focuses on updating notebooks and documentation for the underworld3 codebase. The changes address JOSS review feedback by improving internal solver documentation and updating examples to align with current API usage, particularly replacing deprecated evalf calls with the newer evaluate function. Additionally, a new adaptivity example is improved and dependencies are updated.
- Improved solver documentation with clearer titles and references
- Replaced deprecated
evalf=parameter with_evalf=or removed altogether in favor of newer API patterns - Updated notebook examples to use current API (
evaluateinstead ofevalf)
Reviewed Changes
Copilot reviewed 23 out of 35 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/underworld3/visualisation.py | Added meshio fallback for mesh conversion with try/except block |
| src/underworld3/utilities/_api_tools.py | Minor formatting changes to class definition and markdown headers |
| src/underworld3/systems/solvers.py | Added documentation headers and updated evalf parameter usage |
| src/underworld3/systems/ddt.py | Updated evalf reference and improved docstring formatting |
| src/underworld3/swarm.py | Code cleanup removing outdated comments |
| src/underworld3/function/expressions.py | Fixed LaTeX rendering escape sequence |
| src/underworld3/function/_function.pyx | Bug fixes for function evaluation and variable handling |
| src/underworld3/discretisation.py | Added conditional visualization and improved mesh display |
| src/underworld3/cython/petsc_generic_snes_solvers.pyx | Updated solver documentation headers |
| environment.yml | Added new dependencies: rich, meshio, pygmsh |
| docs/user/_quarto.yml | Updated notebook file references and formatting cleanup |
| docs/user/Notebooks/ | Multiple notebook updates with API changes and improved examples |
Comments suppressed due to low confidence (1)
src/underworld3/systems/solvers.py:2128
- [nitpick] The parameter name
_evalfwith a leading underscore suggests it's private/internal, but it's being used as a public parameter in the function signature. Consider usingevalfwithout the underscore if it's meant to be public.
_evalf=False,
Member
Author
|
This is documentation updating and modifications to JOSS paper. |
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.
Some rewriting of the internal solver documentation in response to JOSS reviews.
Updating notebooks to current codebase (e.g. evalf -> evaluate with rbf argument).
Improving adaptivity example