Repository navigation
Overhaul tutorials & Sphinx docs, fix periodic homogenisation FV stencil, and add CITATION.cff - #305
Open
jameslehoux wants to merge 5 commits into
Open
jameslehoux wants to merge 5 commits into
jameslehoux wants to merge 5 commits into
Conversation
…n periodic homogenisation
… 5 executed tutorials
…TION.cff & pure-Python CI
Performance Benchmark ResultsUniform Block (Analytical τ = 1.0)
Porous Media (MLMG vs HYPRE PCG+SMG, ~55% Porosity)
Fastest uniform solver: mlmg at 64³ (0.0408s) Benchmark: uniform block (analytical τ = 1.0) + smoothed Gaussian porous media |
Code Coverage ReportGenerated by CI — coverage data from gcovr |
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
…t, and expand I/O & CLI coverage
This branch has not been deployed
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.
Summary
Overhauls OpenImpala's tutorial curriculum and Sphinx documentation to a scientific Python standard (
pydata-sphinx-theme+myst-nb), fixes a conservative finite-volume discretisation & CUDA bug in periodic homogenisation, and adds pre-JOSS repository polish (CITATION.cffand multi-version pure-Python CI).1. Conservative Finite-Volume Periodic Homogenisation & CUDA Fix (
src/props/,python/openimpala/_solver.py)0at solid walls), divergence RHSEffDiffFillMtx.H,DeffTensor.H/.cpp,EffectiveDiffusivityHypre.cpp,tEffectiveDiffusivity.cpp, and_solver.py.EffectiveDiffusivityHypre.cppwhen pinning the periodic nullspace cell underOPENIMPALA_USE_GPU(HYPRE_MEMORY_DEVICE), and scale-matches the diagonal pin entry.2. Executed 5-Notebook Tutorial Curriculum & Python Ergonomics (
tutorials/,python/openimpala/)tutorials/andnotebooks/with 5 genuinely executed tutorials (tutorials/01..05_*.ipynb):01_getting_started.ipynb— Exact analytical slab benchmark (02_microstructure_and_anisotropy.ipynb—voxel_size=(dz, dy, dx)03_homogenisation_tensor.ipynb— Periodic corrector cell problems on a tilted laminate, principal-axis eigendecomposition, and periodic vs. Dirichlet flow-through comparison04_multiphase_transport.ipynb— Exact Voigt/Reuss multi-phase verification and nanoporous binder bridging across disconnected macropores05_rev_and_uncertainty.ipynb— Subvolume REV scale convergence (openimpala.datasets(two_phase_stack,two_phase_cubic,sphere_pack,fetch_path), stdlib TIFF support inread_image(),tortuosity_all(),_repr_html_()tables on all 9 result dataclasses, andatexit-managedSession.ensure_active()for multi-cell notebooks.3. Sphinx Documentation,
CITATION.cff& CI (docs/,.github/workflows/)pydata-sphinx-theme,myst-nb(nb_execution_mode = "cache"),sphinx-design, andsphinx-copybutton, rendering all 5 tutorials directly into the online docs alongside updated Diátaxis User Guide and completev4.6+Python/C++ API references.CITATION.cffand updatesREADME.md,CONTRIBUTING.md,docs/changelog.md, andpaper.md.pytestmatrix job (3.9,3.11,3.13) tobuild-test.ymland PR verification (sphinx-build -W+ Doxygen + Breathe + MyST-NB) todocs.yml.Verification
PYTHONPATH=python pytest python/tests/ -v(71 passed, 14 skipped)sphinx-build -W --keep-going -b html docs/ docs/_build/html(0 warnings, 0 errors across all 20 pages and 5 executed notebooks)clang-format --dry-run --Werroracrosssrc/,tests/, andpython/bindings/(0 violations)cffconvert --validate(valid CFF 1.2.0)