Add documentation on the model structure

[ccarouge]

We want people to understand how the coupling is done and what the repercussions are on the model.

@har917 suggests this should involve:

• himself
• @JhanSrbinovsky (particularly around the restart <-> CABLE parts)
• @MartinDix
• @Whyborn (links to ancillary workflows).

@har917 sent a couple of schematics about this.

[bschroeter]

Meeting scheduled to discuss.

[ccarouge]

[ccarouge]

First one legend:

basic explanation – blue is UM code, beige is JULES code, brown is JULES-CABLE coupling code (no science), green is CABLE science code and JULES-CABLE coupling code (where necessary), tl-br diagonal indicates links to output via STASH

Second one legend:

blue
– github, green – collections of inputs on vk83, orange – this experiment’s inputs (dashed is primary area of editing), dark blue - in-cycle executions, brown - output that is deleted, green – output retained

[bschroeter]

General information for a user/developer.

Need legend for what the colours mean.
First one: Top to bottom
Second one: Top to bottom within run

Ben to create template.
Ian, Martin, Jhan, Claire to populate with details.

Stretch goal: Investigate tooltips for the various sections?

[JhanSrbinovsky]

WRT to the flow chart, "ancils repo" and "restarts repo" - do these exist? usually just a vk83 file path right?

[bschroeter]

I have created a branch and uploaded a template from which to work.

Discussions with @Whyborn suggest that documentation/docs/pages/model_components/cable.md is the best place for this to mirror what is done in other models, but I am open to suggestions if there is somewhere more appropriate.

It is all placeholder text at the moment but ready for your input as to the appropriate language to use for headings etc.

Note, the image urls should load for you if you are working locally in VScode or similar, but they will need to be updated to work with the rendered text once we're happy with the text.

Over to you :)