Skip to content

Changes to notebooks and documentation - #9

Merged
lmoresi merged 3 commits into
developmentfrom
joss-revision-fixes
Jul 29, 2025
Merged

Changes to notebooks and documentation#9
lmoresi merged 3 commits into
developmentfrom
joss-revision-fixes

Conversation

@lmoresi

Copy link
Copy Markdown
Member

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

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
CopilotAI review requested due to automatic review settings July 28, 2025 07:00

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 (evaluate instead of evalf)

Reviewed Changes

Copilot reviewed 23 out of 35 changed files in this pull request and generated 4 comments.

Show a summary per file
FileDescription
src/underworld3/visualisation.pyAdded meshio fallback for mesh conversion with try/except block
src/underworld3/utilities/_api_tools.pyMinor formatting changes to class definition and markdown headers
src/underworld3/systems/solvers.pyAdded documentation headers and updated evalf parameter usage
src/underworld3/systems/ddt.pyUpdated evalf reference and improved docstring formatting
src/underworld3/swarm.pyCode cleanup removing outdated comments
src/underworld3/function/expressions.pyFixed LaTeX rendering escape sequence
src/underworld3/function/_function.pyxBug fixes for function evaluation and variable handling
src/underworld3/discretisation.pyAdded conditional visualization and improved mesh display
src/underworld3/cython/petsc_generic_snes_solvers.pyxUpdated solver documentation headers
environment.ymlAdded new dependencies: rich, meshio, pygmsh
docs/user/_quarto.ymlUpdated 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 _evalf with a leading underscore suggests it's private/internal, but it's being used as a public parameter in the function signature. Consider using evalf without the underscore if it's meant to be public.
 _evalf=False,

Comment threadsrc/underworld3/systems/ddt.py
Comment threadsrc/underworld3/function/_function.pyx
Comment threadsrc/underworld3/function/_function.pyx
Comment threadsrc/underworld3/systems/solvers.py
@lmoresi

Copy link
Copy Markdown
MemberAuthor

This is documentation updating and modifications to JOSS paper.

@lmoresi
lmoresi merged commit 73979d8 into developmentJul 29, 2025
2 checks passed
@lmoresi
lmoresi deleted the joss-revision-fixes branch July 29, 2025 06:41
lmoresi added a commit that referenced this pull request Apr 29, 2026
Adds 'EXPERIMENTAL — DO NOT USE FOR PRODUCTION' markers to:
- TransverseIsotropicVEPSplitFlowModel docstring
- The 'hybrid' option description in TransverseIsotropicVEPFlowModel.__init__
Both point readers to EXPONENTIAL_VE_INTEGRATOR.md lessons #9-#11
for why these investigations don't ship and recommend BDF-1 for
deep-yield TI fault problems. Retained on the branch for
reproducibility.
Underworld development team with AI support from Claude Code (https://claude.com/claude-code)
lmoresi added a commit that referenced this pull request May 4, 2026
Adds 'EXPERIMENTAL — DO NOT USE FOR PRODUCTION' markers to:
- TransverseIsotropicVEPSplitFlowModel docstring
- The 'hybrid' option description in TransverseIsotropicVEPFlowModel.__init__
Both point readers to EXPONENTIAL_VE_INTEGRATOR.md lessons #9-#11
for why these investigations don't ship and recommend BDF-1 for
deep-yield TI fault problems. Retained on the branch for
reproducibility.
Underworld development team with AI support from Claude Code (https://claude.com/claude-code)
Sign up for freeto 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.

2 participants

@lmoresi