-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add technical documentation for allocation #1579
Conversation
docs/reference/allocation.qmd
Outdated
----------------- | ----------- | ||
|
||
subnetwork_ids | The unique sorted allocation network IDs | ||
allocation models | The allocation models for the main network and subnetworks corresponding to subnetwork_ids |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are some 'words' in here that look like variables, like subnetwork_ids
. I think for the documentation it is nicer if these variables are described with normal words
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was thinking about using variable-like name so it's easier for developer to look it up.
Co-authored-by: Bart de Koning <[email protected]>
Co-authored-by: Bart de Koning <[email protected]>
Co-authored-by: Bart de Koning <[email protected]>
Co-authored-by: Bart de Koning <[email protected]>
Co-authored-by: Bart de Koning <[email protected]>
Co-authored-by: Bart de Koning <[email protected]>
…into doc-allocation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added some comments on a few places as the description was to vague to properly understand what was meant
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a last few notes, but overall its very nice now (: One last thing you can also add somewhere is that since a recent PR of mine, flow is first allocated to user demand nodes from the directly connected basin without optimization.
Co-authored-by: Bart de Koning <[email protected]>
Co-authored-by: Bart de Koning <[email protected]>
Co-authored-by: Bart de Koning <[email protected]>
Fixes #1540