Skip to content

Add wolf-sheep-soil-creep tutorial#793

Open
joargu wants to merge 18 commits into
precice:developfrom
joargu:develop
Open

Add wolf-sheep-soil-creep tutorial#793
joargu wants to merge 18 commits into
precice:developfrom
joargu:develop

Conversation

@joargu
Copy link
Copy Markdown

@joargu joargu commented May 25, 2026

Description

Added a new wolf-sheep-soil-creep tutorial coupling Mesa (ABM) and Landlab (PDE) via preCICE.

Checklist

Copy link
Copy Markdown
Member

@MakisH MakisH left a comment

Choose a reason for hiding this comment

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

Hi @joargu! This PR is coming out of the blue for me, but it might be the cleanest PR I have ever reviewed for a new tutorial! 😄

I can run the tutorial on my system, which completes in a few seconds (very good for a tutorial). There are no external adapters used, since the two codes are given (both in Python, both already with requirements.txt). I think this would be a nice tutorial, both to showcase coupling with an ABM code, and to showcase a very different application.

You could also add the two codes in the list of third-party adapters, including contact details. At the moment, I have no idea of the context/contact.

I only have two points where this needs improvement: a bit more description, and a fix in the plotting.

Time-wise, this is also good: We are about to make a new release of the tutorials, and it would be great to have this in there.

Comment thread wolf-sheep-soil-creep/precice-config.xml
Comment thread wolf-sheep-soil-creep/README.md Outdated
Comment thread wolf-sheep-soil-creep/README.md
Comment thread wolf-sheep-soil-creep/README.md Outdated
Comment thread wolf-sheep-soil-creep/soil-creep-landlab/soil_creep.py Outdated
@uekerman uekerman self-requested a review May 26, 2026 09:35
Copy link
Copy Markdown
Member

@uekerman uekerman left a comment

Choose a reason for hiding this comment

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

Thanks, @joargu 🙏
I agree that this is already in pretty good shape. I have not run the case yet, but would like to do so once we fix the plotting issue mentioned above.

Only cosmetics below.

Comment thread wolf-sheep-soil-creep/README.md Outdated
Comment thread wolf-sheep-soil-creep/README.md Outdated
Comment thread wolf-sheep-soil-creep/README.md Outdated
Comment thread wolf-sheep-soil-creep/README.md Outdated
Comment on lines +10 to +12
hstar = 0.2
fast_creep = 0.1
slow_creep = 0.001
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could you add some comments here on what these parameters mean?

Comment thread wolf-sheep-soil-creep/soil-creep-landlab/soil_creep.py

# Run the soil-creep model
prior_elev[:] = elev
diffuser.run_one_step(dt)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I guess this updates elev? Where could I see more about this?
(a comment could probably be good here)

Comment on lines +12 to +14
# Use dx of Raster Model Grid from Soil Creep for solver_dt calculation
dx = 1.0
fast_creep = 0.1
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The dx here also makes sense from the perspective of MESA, right? But the fast_creep doesn't.
Maybe it could be easier to simply hard-code the solver_dt here and comment that we do this to ensure matching time step sizes.

joargu and others added 5 commits May 26, 2026 20:43
Co-authored-by: Benjamin Uekermann <benjamin.uekermann@gmail.com>
Co-authored-by: Benjamin Uekermann <benjamin.uekermann@gmail.com>
@joargu
Copy link
Copy Markdown
Author

joargu commented May 26, 2026

The plotting issue should be fixed now. The figure PNGs are written to soil-creep-landlab/output.

Comment thread wolf-sheep-soil-creep/soil-creep-landlab/run.sh Outdated
joargu and others added 2 commits May 27, 2026 08:35
Co-authored-by: Gerasimos Chourdakis <gerasimos.chourdakis@ipvs.uni-stuttgart.de>
@uekerman
Copy link
Copy Markdown
Member

I was able to run the case and reproduce the expected results.

@joargu
Copy link
Copy Markdown
Author

joargu commented May 27, 2026

I extended the tutorial description, mentioned the source notebook and licensing, and added a note about the output directory under post-processing.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants