Allocation diagram

[SouthEndMusic]

Fixes #761.

[SouthEndMusic]

Here is a first draft of a diagram of the interaction between the Ribasim simulation and the allocation optimization. @visr @deltamarnix I would like to hear your feedback.

[visr]

This is really nice to have! The diagram matches my understanding as well, left a few minor comments.

[deltamarnix]

Hey that's a good start! I would like to see in the image maybe:

• Are these two loops themselves also looped? Or is this really one time only?
• How is the allocation process started? There must be some starting point in the code.
• Are the Ribasim process and the allocation process really two different executables/processes. Or are we talking about modules within the same application?

Good use of dashed arrows and activity bars!

[SouthEndMusic]

@deltamarnix go wild :)

[SouthEndMusic]

Updated version:

[SouthEndMusic]

One could argue that the latest version above contains to much detail for where it is in the docs. Maybe this version could be in the developer docs and a stripped version where this one is now

[deltamarnix]

Maybe a simple flowchart for the other part?

flowchart LR
Start((Start))
Allocate
Simulate
Timestep{Timestep ready?}
Finished{Finished?}
Done((Done))

Start --> Allocate
Allocate --> Simulate
Simulate --> Timestep
Timestep -->|no| Simulate
Timestep -->|yes| Finished
Finished -->|no| Allocate
Finished -->|yes| Done

Loading

flowchart LR
Start((Start))
Allocate
Simulate
Timestep{Timestep ready?}
Finished{Finished?}
Done((Done))

Start --> Allocate
Allocate --> Simulate
Simulate --> Timestep
Timestep -->|no| Simulate
Timestep -->|yes| Finished
Finished -->|no| Allocate
Finished -->|yes| Done