Python examples in couple your code use precice as participant object which leads to misunderstandings

[fsimonis]

Page URL

https://precice.org/couple-your-code-mesh-and-data-access.html

What is wrong?

When copying this to a file where the participant isn't called precice, then precice refers to the module, leading to strange errors.

We should rename the instance

[MakisH]

What I like about the current naming is that it is clear which line of code comes from preCICE, and that it is consistent with the C++ version, so you can directly compare the two versions.

I see the issue, but I wonder if we could work around it with an error message or more documentation.

If we were to rename it: I don't really like the participant we used to have, as this is rather preCICE-internal terminology. And the older interface is also rather generic. How about coupling?

coupling.advance(), coupling.write_data(), ...

In any case, if we renamed it to anything else, there would again be an error, just less confusing, right?

[fsimonis]

In any case, if we renamed it to anything else, there would again be an error, just less confusing, right?

Correct. This is the only reason to rename IMO.

We could just use p to keep it short.
This leaves more horizontal space for arguments.

[MakisH]

I like p more than the alternatives.

But while changing it could help those that run into that situation by mistake, I do find the current way much easier to read, understand, and explain: If one sees a long code snippet, it is easier to navigate if we have precice., instead if we have just a p. that one would need to first check where it is defined (especially since we also have np.).

If we want to solve this without making it easier to navigate, the opposite direction would also be valid, making it longer: precice_p would be uglier but satisfy both needs.

[fsimonis]

I think it makes sense to sit together and look at the website with the different versions.

We should also keep the naming between the Cpp and the Python versions consistent.

I'll add a card to the CD agenda