Skip to content

docs: add scalability guidance#1413

Open
william-xue wants to merge 1 commit into
PowerGridModel:mainfrom
william-xue:docs/add-scalability-guidance
Open

docs: add scalability guidance#1413
william-xue wants to merge 1 commit into
PowerGridModel:mainfrom
william-xue:docs/add-scalability-guidance

Conversation

@william-xue
Copy link
Copy Markdown

Summary

Adds a short scalability section to the performance guide, covering radial versus meshed grid behavior and the batch-related factors that affect runtime and memory use.

Closes #1096.

Validation

  • git diff --check
  • Python content check for the new scalability section

Signed-off-by: xueyuan <xueyuan@tode.com>
Copy link
Copy Markdown
Member

@mgovers mgovers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @william-xue,

It looks like you're using AI to help generate this code (I'm also looking at #1412). While it is OK to do so, please make sure to check whether the original question is actually resolved. This will help reduce the workload on maintainers. It is also strongly recommended to first resolve open PR's you're working on to reduce the simultaneous work.

## Scalability

The calculation workload generally depends on the number of connected grid elements and on the network topology.
For radial distribution grids, most calculation steps scale close to linearly with grid size.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For radial distribution grids, most calculation steps scale close to linearly with grid size.
For radial distribution grids, all calculation steps scale (amortized) linearly with grid size.

It's probably also good to explicitly state that it is O(n_nodes + n_branches + ...)


The calculation workload generally depends on the number of connected grid elements and on the network topology.
For radial distribution grids, most calculation steps scale close to linearly with grid size.
Meshed grids require more coupling between buses and branches, so some steps can scale less favorably.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Meshed grids require more coupling between buses and branches, so some steps can scale less favorably.
Meshed grids require more coupling between buses and branches and will result in quadratic scaling in the largest loop in the mesh (worst case: `O(n_nodes * n_branches)`)

In both cases, runtime and memory usage are also affected by the number of batch scenarios, the amount of update data per
scenario, and whether the topology can be reused between scenarios.

```{note}
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this note should not be part of this section; please restore the original order

Meshed grids require more coupling between buses and branches, so some steps can scale less favorably.
In both cases, runtime and memory usage are also affected by the number of batch scenarios, the amount of update data per
scenario, and whether the topology can be reused between scenarios.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since someone reading this is interested in scalabiltity, and we've already done the full analysis in https://github.com/orgs/PowerGridModel/discussions/24 , please:

@mgovers mgovers added the documentation Improvements or additions to documentation label Jun 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[IMPROVEMENT] Update performance guide with scalability

2 participants