Skip to content
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

Merged
merged 45 commits into from
Jul 31, 2024
Merged

Add technical documentation for allocation #1579

merged 45 commits into from
Jul 31, 2024

Conversation

Jingru923
Copy link
Contributor

Fixes #1540

@Jingru923 Jingru923 linked an issue Jun 24, 2024 that may be closed by this pull request
----------------- | -----------

subnetwork_ids | The unique sorted allocation network IDs
allocation models | The allocation models for the main network and subnetworks corresponding to subnetwork_ids
Copy link
Collaborator

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

Copy link
Contributor Author

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.

@Jingru923 Jingru923 marked this pull request as ready for review July 1, 2024 09:58
Copy link
Contributor

@gijsber gijsber left a 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

docs/dev/allocation.qmd Outdated Show resolved Hide resolved
docs/dev/allocation.qmd Outdated Show resolved Hide resolved
docs/dev/allocation.qmd Outdated Show resolved Hide resolved
docs/dev/allocation.qmd Outdated Show resolved Hide resolved
docs/dev/allocation.qmd Outdated Show resolved Hide resolved
docs/dev/allocation.qmd Outdated Show resolved Hide resolved
docs/dev/allocation.qmd Outdated Show resolved Hide resolved
Copy link
Collaborator

@SouthEndMusic SouthEndMusic left a 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.

@Jingru923 Jingru923 merged commit 38cab4f into main Jul 31, 2024
21 of 27 checks passed
@Jingru923 Jingru923 deleted the doc-allocation branch July 31, 2024 06:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document allocation (for developers)
3 participants