search

precice / config-visualizer

A small python tool for visualizing the preCICE xml configuration
https://pypi.org/project/precice-config-visualizer/
GNU General Public License v3.0
10 stars 4 forks source link

How to visualize acceleration #20

Open fsimonis opened 6 months ago

fsimonis commented 6 months ago

Acceleration is a big part of preCICE configuration files, but we currently have no visualization for it.

The question is how can we effectively visualize acceleration without adding too much clutter.

Problem I noticed for parallel schemes is that all exchanged data is accelerated (both directions), which makes a central node to represent the acceleration very confusing.

A simple option could be to add the information as a mouse-over to exchange tags and choose a different head/tail.

More context

https://precice.org/configuration-acceleration.html

MakisH commented 6 months ago

I think that 80% of the interesting part is which acceleration method we are using. For this, I would expect a box inside the coupling scheme with the name of the acceleration.

That box could then optionally include the XLM tags as text. This would allow someone to access these details when helping someone tune a case, without visually bloating too much the figure. Something like:

acceleration drawio

Could even just include a dump of the respective XML config, if that is easier to implement.

A simple option could be to add the information as a mouse-over to exchange tags and choose a different head/tail.

Please keep the CLI full-featured. Mouse-over elements would be nice for someone working on their computer, but it would make it difficult to interact with others.