Contributing to Examples

[surbhidhiman]

Hi Oceananigans community,
I noticed that there is no two dimensional diffusion example, would this be a valuable contribution to the community? If not, are there any particular examples that might be nice to see?
Thank you!

[glwagner]

Here is a short answer, though a longer discussion may be warranted. Right now I don't think we are limited by our ability to write examples, but rather by our ability to run examples as part of our testing framework. Examples are fairly expensive, so we cannot add too many without bogging down the test infrastructure, and thus slowing down development. This by itself is a problem --- it'd be nice to have more resources for building docs (and also ways to build docs with multiple GPUs / multiple machines, rather than the single machine paradigm we are using now).

That said, I think the examples that are most sorely needed right now are cases on the sphere (I have a baroclinic instability case lined up) and examples that use ImmersedBoundaryGrid. These are poorly represented in the examples now.

We should discuss your idea though. What do you mean by "two dimensional diffusion". Do you mean something that uses ScalarDiffusivity?

[francispoulin]

Hello @surbhidhiman , I presume you have run the one dimensional example and maybe other examples? If you have then you can adapt it to do a two dimensional case by just changing the grid.

If you make either the x ro y dimensions from Flat to Bounded or Periodic and then change the size and extend (you can look at the two dimensional turbulence to see how this should work) them the example should run easily in two dimensions. The plotting would need to be changed but the simulation part should work.