Repository of complex transformations

[hiker]

We now have several quite complex transformation scripts developed (either as part of PSyclone, or by users). It is very hard to find even the examples that are included in PSyclone (in various example directories, e.g. examples/lfric/scripts, examples/nemo/screipts, ... and I am adding more in various tutorials).

It would be quite useful to have some kind of repository with complex examples. Ideally sorted by what kind of transformation they do (not necessarily by domain, which we have atm) - eg. replacing an array with scalar is independent of domain or even generic Fortran. Plus it needs a high-level overview (stand-alone document, or maybe chapter in the user's guide??) where a user can easily browse.

[LonelyCat124]

I think Chris also wanted something like this as part of NG-ARCH - I'm not sure if there was any decision on where this kind of stuff should live/should it be inside PSyclone? @arporter @sergisiso

[arporter]

Good point. I think the plan is to re-process the PSyACC repo @christophermaynard but I can't remember whether that is public? The plan was to upstream as much as possible into PSyclone (eventually).

[sergisiso]

Do we need a separate thing? Is it not enough if we refactor the user_guide transformation page with as ToC as suggested in #2860 ?

[hiker]

As mentioned, I am happy with a separate chapter in the user's guide. But we probably also should have a separate directory(??) under examples so we can actually test them (or just add to the directories under the existing examples?). I can't really decide if I want the actual code included the guide - it would be useful for some shorter examples (1-2 pages) - could be a good way of studying it? But thinking of LFRic/nemo with rather complex code, that would definitely too much.

It should probably have a kind of learning curve - some easy and reasonable short document, the rest maybe explained, and pointed to in the examples directories?