Adds a tutorial on shaping and related capabilities#1656

Merged

kennyweiss merged 58 commits intodevelopfrom

feature/shaping-tutorial

Nov 6, 2025

Member

kennyweiss commented Sep 15, 2025 •

edited

Loading

Summary

This PR adds a new Axom tutorial on "shaping" geometry into multimaterial simulations
It was presented as part of LLNL's 2025 HPC tutorial series: https://hpcic.llnl.gov/tutorials/2025-hpc-tutorials
Per advice from @white238, I added the tutorials to our typical build when the new config variable AXOM_ENABLE_TUTORIALS is set, and have defaulted this to ON.
I also updated our svg2contours script to use svgpathtools@1.7.1
- This incorporates our old patches (which I've removed),
- ... but requires a new patch (which I've upstreamed Bugfix for transformations on Arcs mathandy/svgpathtools#238)

TODO:

Update svgpathtools patch based on actual commit
Follow suggestions from 9/16 tutorial feedback #1657
Take another editing pass through the tutorial
Confirm changes to build_tpls against our spack specs

kennyweiss force-pushed the feature/shaping-tutorial branch 4 times, most recently from 2a4b643 to 2400d16 Compare

October 3, 2025 21:45

kennyweiss marked this pull request as ready for review

October 3, 2025 23:15

kennyweiss requested review from Arlie-Capps, BradWhitlock, bmhan12, cyrush, gunney1, jcs15c, ltaylor16, nselliott, publixsubfan, rhornung67, white238 and wnissen

October 3, 2025 23:27

kennyweiss self-assigned this

kennyweiss added enhancement Sidre Quest Documentation Inlet Klee labels

BradWhitlock reviewed

View reviewed changes

scripts/spack/packages/axom/package.py

                   variant("examples", default=True, description="Build examples")
                   variant("tools", default=True, description="Build tools")
+                  variant("tutorials", default=True, description="Build tutorials")

Member

BradWhitlock Oct 6, 2025

It's minimal added build time, right? I would think most people using Spack to build Axom just care about getting a library to link into their project.

BradWhitlock reviewed

View reviewed changes

src/axom/core/utilities/About.cpp.in

BradWhitlock reviewed

View reviewed changes

src/examples/CMakeLists.txt

BradWhitlock reviewed

View reviewed changes

src/examples/radiuss_tutorial/lesson_03/README.md

BradWhitlock reviewed

View reviewed changes

src/examples/radiuss_tutorial/lesson_04/README.md Outdated

BradWhitlock reviewed

View reviewed changes

src/examples/radiuss_tutorial/lesson_04/README.md Outdated

kennyweiss and others added 26 commits

November 5, 2025 16:49


          updates instructions for tutorial

44144c3


          adds some figs

f78cdb1


          Hack to build on tutorial images (disable examples due to insufficien…

8dbd913

…t space)


          Adds images

46eb60b


          Restore AXOM_USE_EXAMPLES for building axom examples

53607ba


          Adds AXOM_DEVELOP_TUTORIALS option

c728e8c

This builds the tutorials as part of an Axom build and is mostly helpful when developing the tutorials.


          Adds optional unit tests to shaping tutorial

662df10


          Rename option to AXOM_ENABLE_TUTORIALS

610c1de

Per suggesion from C. White.


          Add guards for building tutorials and fix compilation error

75af7b4

The shaping tutorial requires Klee, Inlet, Sidre and Conduit.
(I only added a check for Klee, since it explicitly checks for the others).


          Incoporates shaping_tutorial into CI build

2284cbf

Defaults AXOM_ENABLE_TUTORIALS to ON
and adds a spack variant 'tutorials' to the Axom package.


          Fixes tutorial build in non-RAJA/Umpire configs

4a181a9


          Fix for a CI build

3658de1


          Minor edit

3168a85


          Fixes and updates radiuss tutorial for gcc@13 w/ C++20

e142368


          Fixes some gcc@13 warnings

8a667a6


          Fixes for intel config (which does not have mfem)

7bfb493


          Updates svgpathtools patch to upstreamed commits

702cedc


          Review pass through lesson 00

2f6a0ff


          Review pass through lesson 01

4d5623b


          Review pass through lesson 02

e3b2e50


          Review pass through lesson 03

aff0aa4


          Review pass through lesson 04

5aa3edd


          make style

1c402d3


          Fixes some typos, per PR review

935fed4


          Updates RELEASE-NOTES

dfc7069


          make style

15387aa

kennyweiss force-pushed the feature/shaping-tutorial branch from 9c8b7e5 to 15387aa Compare

November 6, 2025 01:08

kennyweiss merged commit 74cf08d into develop

15 checks passed

kennyweiss deleted the feature/shaping-tutorial branch

November 6, 2025 05:21

kennyweiss mentioned this pull request

9/16 tutorial feedback #1657

Closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

BradWhitlock BradWhitlock approved these changes

rhornung67 rhornung67 approved these changes

Arlie-Capps Arlie-Capps approved these changes

white238 Awaiting requested review from white238

cyrush Awaiting requested review from cyrush

wnissen Awaiting requested review from wnissen

nselliott Awaiting requested review from nselliott

publixsubfan Awaiting requested review from publixsubfan

jcs15c Awaiting requested review from jcs15c

ltaylor16 Awaiting requested review from ltaylor16

gunney1 Awaiting requested review from gunney1

bmhan12 Awaiting requested review from bmhan12

Labels

Documentation enhancement Inlet Klee Quest Sidre