Adding design notes on core data setup and configuration

[davidorme]

This pull request provides a proposal for the data initialisation process.

Fixes #64

Type of change

• New feature (non-breaking change which adds functionality)
• Optimization (back-end change that speeds up the code)
• Bug fix (non-breaking change which fixes an issue)

Key checklist

• Make sure you've run the pre-commit checks: $ pre-commit run -a
• All tests pass: $ poetry run pytest

Further checks

• Code is commented, particularly in hard-to-understand areas
• Tests added that prove fix is effective or that feature works

[codecov-commenter]

Codecov Report

Merging #65 (f737745) into develop (08fd3e9) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop      #65   +/-   ##
========================================
  Coverage    75.86%   75.86%           
========================================
  Files            3        3           
  Lines           58       58           
========================================
  Hits            44       44           
  Misses          14       14           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[jacobcook1995]

Made a couple of comments, also am wondering whether this actually should close issue #64, which it currently will automatically when merged

[davidorme]

That's a good point about closing - I intended the issue just to provide the proposal for discussion, but it might as well serve to cover the implementation.

This would have been better as a GH discussion!

[vgro]

Could you please explain this a bit more? When would this apply?

[davidorme]

Hard to define! But if someone wanted to simulate a scenario of 5 drought years followed by 3 years of elevated rainfall then an El Niño and then a plague of frogs - that's probably outside the scope 😄

[vgro]

Looks very good, clear starting point to design the core set up and config.
Maybe we can start a discussion for more details on data inputs types/format and grid shapes?

[vgro]

Thanks for adding examples and clarification ( I'm just making sure it's idiot proof ;-) ). I think the document is very clear now, ready to merge from my point of view 👍