Skip to content

docs: link LF Energy landing page#1412

Open
william-xue wants to merge 1 commit into
PowerGridModel:mainfrom
william-xue:docs/link-lf-energy
Open

docs: link LF Energy landing page#1412
william-xue wants to merge 1 commit into
PowerGridModel:mainfrom
william-xue:docs/link-lf-energy

Conversation

@william-xue

@william-xue william-xue commented May 29, 2026

Copy link
Copy Markdown

Summary

  • Add a link from the documentation landing page to the LF Energy Power Grid Model project page

Validation

  • Verified the LF Energy project page returns HTTP 200
  • Ran git diff --check
  • Checked that docs/index.md contains the new link

Part of #1020

Signed-off-by: xueyuan <xueyuan@tode.com>

@mgovers mgovers left a comment

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.

Hi @william-xue,

Thank you again for your contribution!

After this PR is merged, can you please also do a similar change on the power-grid-model-io repository and power-grid-model-ds repository? It's probably good to homogenize these things as much as possible.

Comment thread docs/index.md
Comment on lines 15 to 29
`power-grid-model` is a library for steady-state distribution power system analysis.
It is distributed for Python and C.
The core of the library is written in C++.
Power Grid Model is an LF Energy project; see the [LF Energy landing page](https://lfenergy.org/projects/power-grid-model/).
Currently, it supports both symmetric and asymmetric calculations for the following calculation types:

* Power Flow
* State Estimation
* Short Circuit

For conversions from various data format to the power-grid-model, refer to the
[power-grid-model-io](https://github.com/PowerGridModel/power-grid-model-io) repository.
For an extended python interface to the the power-grid-model, refer to the
[power-grid-model-ds](https://github.com/PowerGridModel/power-grid-model-ds) repository.

@mgovers mgovers May 29, 2026

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.

Either make LFE a first-class citizen

Suggested change
`power-grid-model` is a library for steady-state distribution power system analysis, hosted by the Linux Foundation Energy (see also the
[LF Energy landing page](https://lfenergy.org/projects/power-grid-model/)).
It is distributed for Python and C.
The core of the library is written in C++.
Currently, it supports both symmetric and asymmetric calculations for the following calculation types:
* Power Flow
* State Estimation
* Short Circuit
For conversions from various data format to the power-grid-model, refer to the
[power-grid-model-io](https://github.com/PowerGridModel/power-grid-model-io) repository.
For an extended python interface to the the power-grid-model, refer to the
[power-grid-model-ds](https://github.com/PowerGridModel/power-grid-model-ds) repository.

or first describe the whole business case and then mention LFE

Suggested change
`power-grid-model` is a library for steady-state distribution power system analysis.
It is distributed for Python and C.
The core of the library is written in C++.
Currently, it supports both symmetric and asymmetric calculations for the following calculation types:
* Power Flow
* State Estimation
* Short Circuit
For conversions from various data format to the power-grid-model, refer to the
[power-grid-model-io](https://github.com/PowerGridModel/power-grid-model-io) repository.
For an extended python interface to the the power-grid-model, refer to the
[power-grid-model-ds](https://github.com/PowerGridModel/power-grid-model-ds) repository.
Power Grid Model is an LF Energy project; see the
[LF Energy landing page](https://lfenergy.org/projects/power-grid-model/).

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds a documentation pointer from the docs landing page to the project’s official LF Energy project page, aligning the documentation with Issue #1020’s request to surface the LF Energy landing page from within the docs.

Changes:

  • Add an explicit external link on docs/index.md to the LF Energy “Power Grid Model” project page.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@mgovers mgovers left a comment

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.

Please resolve the open comments + failing CI first

@figueroa1395 figueroa1395 added the documentation Improvements or additions to documentation label Jun 8, 2026
@figueroa1395

figueroa1395 commented Jun 15, 2026

Copy link
Copy Markdown
Member

Hello @william-xue, will you continue working on this PR?

Edit: @william-xue Pinging you again since you recently closed your other open PR. This PR doesn't need much additional work, so let us know if you want to finish it, and feel free to PING us for any assistance, we are happy to help.

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.

4 participants