Plant data preparation details docs

[jacobcook1995]

Description

This PR adds a section for the specific data needs of the plant model to the user docs. This is based partly on what was already in the user docs and partly based on feedback from @arne-exe.

@arne-exe I made most of the smaller changes you suggested about the flow of the documents. Though annoyingly I couldn't get the link to the correct view of the variable table to work in text (it's quite fiddly/brittle even when it's on its own line). If there's anything else you feel should be altered feel free to suggest it

The point about the axis information is a really good one, but not one we can address at the moment. I made an issue to track this (see #1445)

A lot of the other comments were about making sure the variables had up to date descriptions/values. This isn't really something I can do as I'm not familiar enough with the plants model, when I asked David about this he said it isn't something he has time to address pre-MVP. So I think it's best kicked down the road till then (i.e. post Easter). What I did was go through the issues you've raised and addressed the ones where the change that needed to be made was clear to me. This only turned out to be two issues, but at least that's a start.

@davidorme, if you could also check that the changes look sane that would be great!

This is the relevant documentation to look at

Fixes #1377
Fixes #1379

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.09%. Comparing base (44dc4fc) to head (e027ca7).

Additional details and impacted files

@@                   Coverage Diff                   @@
##           feature/docs-ui-update    #1448   +/-   ##
=======================================================
  Coverage                   94.09%   94.09%           
=======================================================
  Files                          72       72           
  Lines                        7581     7581           
=======================================================
  Hits                         7133     7133           
  Misses                        448      448           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[arne-exe]

Hi Jacob, thanks for including these changes, this looks good.
I've added a few small extra changes.

[arne-exe]

@arne-exe I made most of the smaller changes you suggested about the flow of the documents. Though annoyingly I couldn't get the link to the correct view of the variable table to work in text (it's quite fiddly/brittle even when it's on its own line). If there's anything else you feel should be altered feel free to suggest it

No worries, it would have been nice to add this if there was an easy way to do it but this is not essential.

The point about the axis information is a really good one, but not one we can address at the moment. I made an issue to track this (see #1445)

Alright.

A lot of the other comments were about making sure the variables had up to date descriptions/values. This isn't really something I can do as I'm not familiar enough with the plants model,

Yeah makes sense, I am quite familiar with the plants model (or like to think I am) but it's hard for me to verify if descriptions match the calculations in the code due to the unfamiliar syntax in the code. It also doesn't help that many of the descriptions are either vague or open for interpretation in multiple ways.

when I asked David about this he said it isn't something he has time to address pre-MVP. So I think it's best kicked down the road till then (i.e. post Easter).

I understand, deciding the priority of this given your timeline is up to you. I can see how this is less important from a coding perspective, but I think it's fair to say that from a calibration point of view this is a serious concern. I do hope that this is not something that gets buried and forgotten.

What I did was go through the issues you've raised and addressed the ones where the change that needed to be made was clear to me. This only turned out to be two issues, but at least that's a start.

Thanks for doing that Jacob!

[davidorme]

One minor comment