Skip to content

Development - synchronise changes to documentation / JOSS - #11

Merged
lmoresi merged 5 commits into
mainfrom
development
Jul 29, 2025
Merged

Development - synchronise changes to documentation / JOSS#11
lmoresi merged 5 commits into
mainfrom
development

Conversation

@lmoresi

Copy link
Copy Markdown
Member

No description provided.

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
Changes to notebooks and documentation - push through to dev / main so that the API builds etc reflect the updates.
CopilotAI review requested due to automatic review settings July 29, 2025 06:43

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 synchronizes changes to documentation and JOSS paper, updating code formatting, docstrings, solver display names, dependencies, and notebooks to align with development improvements.

Key Changes

  • Updated solver display names and documentation headers for consistency
  • Refactored visualization code to use meshio when available with fallback to PyVista
  • Enhanced error handling and removed redundant code comments
  • Updated dependencies and notebook formatting

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.pyRestructured mesh conversion to use meshio as primary method with PyVista fallback
src/underworld3/utilities/_api_tools.pyUpdated class definition syntax and markdown header formatting
src/underworld3/systems/solvers.pyEnhanced docstrings with consistent headers and updated parameter naming
src/underworld3/systems/ddt.pyImproved class documentation formatting
src/underworld3/swarm.pyUpdated comments and added particle migration cleanup
src/underworld3/function/expressions.pyFixed LaTeX rendering escape sequence
src/underworld3/function/_function.pyxImproved iteration and removed redundant code
src/underworld3/discretisation.pyEnhanced mesh viewing with conditional visualization
src/underworld3/cython/petsc_generic_snes_solvers.pyxUpdated solver display names and documentation headers
environment.ymlAdded new dependencies (rich, meshio, pygmsh)
docs/user/_quarto.ymlUpdated notebook file names and cleaned formatting
docs/user/Notebooks/html5/temperature_plot.htmlUpdated base64 data for visualization
docs/user/Notebooks/Notebook_Index.ipynbUpdated notebook references and Python version
docs/user/Notebooks/8-Particle_Swarms.ipynbImproved code formatting and documentation
docs/user/Notebooks/7-Unsteady_Flow.ipynbEnhanced documentation and code structure
Comments suppressed due to low confidence (1)

src/underworld3/systems/solvers.py:2128

  • [nitpick] Parameter name _evalf uses a leading underscore which typically indicates a private/internal parameter, but this appears to be a user-facing API parameter that should use a more descriptive public name.
 _evalf=False,

Comment threadsrc/underworld3/visualisation.py Outdated
Comment threadsrc/underworld3/visualisation.py Outdated
Comment threadsrc/underworld3/function/_function.pyx
Comment threadsrc/underworld3/function/_function.pyx
@lmoresi
lmoresi merged commit 3338840 into mainJul 29, 2025
5 checks passed
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