Moving relevant v3 tutorials to v4 examples folder

[erikvansebille]

Description

This PR updates the old tutorials in examples-v3 folder; removing some that are not relevant anymore (e.g. on zarr output) and updating the others to v4 API

Note that, with this PR, we'll likely use more than the 15 minutes of ReadTheDocs build time on their free plan, so we need to think about how to build the documentation...

Checklist

• Closes None
• Tests added
• This PR targets the correct branch (main for normal development, v3-support for v3 support)

AI Disclosure

None

[VeckoTheGecko]

Should we make a distinction anymore between documentation_...ipynb and tutorial_...ipynb? From what I understand we intend to run them all in CI?

In a future PR/at the end of this one maybe we should do renamings

[erikvansebille]

Should we make a distinction anymore between documentation_...ipynb and tutorial_...ipynb? From what I understand we intend to run them all in CI?

In a future PR maybe we should do renamings

Good point; the distinction between documentation_...ipynb and tutorial_...ipynb is a relic from v3, when only the tutorial notebooks were run in CI. But now indeed we will run all of them.

The only 'notebook' that shouldn't run on CI is the homepage_animation one - because it takes approximately 30 minutes just to compute the full set of trajectories. But that's why I now made it a markdown file with code cells that aren't triggered on CI

Why shall I not do the renaming to tutorials-* in this PR?

[VeckoTheGecko]

Why shall I not do the renaming to tutorials-* in this PR?

Doing so in a separate PR or at the end of this one would be good. I'm mid-review at the moment, so doing the renaming right now would mean that I have to resubmit my other review comments.

[VeckoTheGecko]

a couple clarifications - happy to merge after those are discussed

[VeckoTheGecko]

I think that this change is the wrong way around and should be U=["YC", "XG"]?

• YC -> Y-axis centers
• YG -> Y-axis edges
• XC -> X-axis centers
• XG -> X-axis edges

I don't think its urgent to fix in this PR - perhaps just add a TODO. I'm wondering what the error was that led to this change?

[erikvansebille]

No, the U-velocities are defined on the center of the right y-edges (which are located at XC). See also the plot below

Furthermore, with this definition the results agree with the v3 version. I updated this function when moving the tutorial_peninsula_AvsCgrid over to v4.

[erikvansebille]

Why shall I not do the renaming to tutorials-* in this PR?

Doing so in a separate PR or at the end of this one would be good. I'm mid-review at the moment, so doing the renaming right now would mean that I have to resubmit my other review comments.

Now done in 3dfb6f5