Callstack visualization

[SouthEndMusic]

Fixes #1472.

[SouthEndMusic]

Obtaining the call graph seems to work well. We should just restrict it to smaller parts of the code, not an entire run. For visualization I went with a Makie approach, here is an example for Parameters:

We can debate very long about what the best way would be to visualize the data, but because it gets very dense very quickly I think this plot is best used interactively. I do think the color coding by script is quite nice.

Some other formatting ideas are:

• Pruning non-Ribasim calls
• Clustering by script

[evetion]

Great effort! 💯

Would it be useful to depend on https://graph.makie.org/stable/generated/depgraph/? The current layout seems quite constrained, ideally you have an automatic graph layout.

For interactivity, a script in utils might be a better fit? Or a new util folder in docs, so the quarto notebook is a bit shorter?

Did you test this with a single calculation timestep as well?

Finally, given your slack question, any progress on an mermaidjs translation?

[SouthEndMusic]

I feel like I'm converging towards something usable. I now sort per layer the names per script, leave out non-Ribasim calls (which can lead to floating branches because Ribasim calls can happen from non-Ribasim calls), and squash per layer calls with the same name into one.

And an example of water_balance!:

We could also make a distinction between different methods of a function, but including the signatures can get messy.

[SouthEndMusic]

Possibly all function names starting with # can be taken out, as they are not informative. I think some of them are created by @kwdef

[SouthEndMusic]

Improved formatting, generated functions cut out:

[SouthEndMusic]

The graph for a run of the allocation algorithm:

I also want to show allocation initialization but for some reason the call trace code crashes on that at the moment (edit: now fixed).

[SouthEndMusic]

Ah I forgot DiscreteControl

[evetion]

Looking good 🚀. Two remarks before we merge:

• Maybe good to make some links from the equations/implementation page to each specific plot?
• In the plots all the Ribasim. prefixes should be removed.

edit:
Maybe remove the spines/axes labels/ticks with hidedecorations! and/or the minimal theme.

[evetion]

Maybe add the update_cumulative_flows callback here as well? That should cover most of the core code.

[SouthEndMusic]

I decided against adding this because update_cumulative_flows! calls very few other (Ribasim) functions.