Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@ggorman
Copy link
Contributor

@ggorman ggorman commented Jan 29, 2026

No description provided.

- Update GitHub links from hplgit/fdm-book to devitocodes/devito_book
- Simplify DocOnce-style conditional refs to direct Quarto @sec- syntax
- Fix broken external URLs (SciPy, Boost Python, SIP, Shiboken)
- Fix typo: "through" → "trough" in wave terminology
- Update Computational Physics PDF URL in references.bib
- Pedagogical philosophy: theory before code, Lax equivalence foundation,
  error analysis throughout, progressive complexity, reproducibility
- Document content gaps from roadmap analysis: elliptic PDEs, high-order
  schemes, SBP/mimetic methods, curvilinear grids, adjoint methods
- Contribution guidance for each gap with SymPy/Devito examples
- Chapter template for new content structure
- Standards for SymPy math derivations, Devito solver patterns
- Code verification hierarchy (exact solutions, MMS, conservation)
- Plotting, image generation, and Quarto guidelines
- Testing, linting, and local development instructions
- Attribution and licensing requirements
The wave equation example in index.qmd used `Eq(u.dt2, c**2 * u.dx2)`
which generates invalid C code (assigns to an expression). Fixed to use
`solve()` to derive the explicit update stencil.

The diffusion example in what_is_devito.qmd used `alpha` and `dt` without
defining them. Fixed by adding parameter definitions and using the
`solve()` pattern for consistency.

Added test_book_code_verification.py to verify code examples are correct.
Tests verify Devito code examples from:
- devito_abstractions.qmd: Grid, Function, TimeFunction, 2D diffusion
- boundary_conditions.qmd: Dirichlet BCs, subdomain method, complete solver
- advec1D_devito.qmd: Upwind, Lax-Wendroff, Lax-Friedrichs schemes

All 14 new tests pass, ensuring code snippets in the book compile
and produce correct results.
@codecov
Copy link

codecov bot commented Jan 29, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 48.18%. Comparing base (ad72950) to head (baf2253).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #100   +/-   ##
=======================================
  Coverage   48.18%   48.18%           
=======================================
  Files           4        4           
  Lines         330      330           
  Branches       48       48           
=======================================
  Hits          159      159           
  Misses        158      158           
  Partials       13       13           
Flag Coverage Δ
derivations 48.18% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ggorman ggorman merged commit fb32dc7 into main Jan 29, 2026
11 checks passed
Sign up for free to 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