Skip to content

[IMPROVEMENT] Add section on PowerGridModelInterface to docs #290

Description

@vincentkoppen

Problem faced

With the current docs we briefly mention the PowerGridModelInterface in the Quick start and some examples, but this deserves a more prominent spot. Since almost all users of PGM-DS will use it together with PGM.

What we currently have:

(Seperated from the discussion in #288)

Improvement proposal

Add a new section to the docs on PowerGridModelInterface that is directly between Model Interface and Examples in the left bar of our docs.

The first version can be brief:

  • Show how to use it to perform a calculation
  • How to go from grid -> input_data
  • How to go from input_data -> grid

Community Meeting

  • I wish to discuss this improvement in the bi-monthly PGM community meeting. Please join the PGM community meeting.

Metadata

Metadata

Assignees

No one assigned

    Labels

    improvementImprovement on internal implementation

    Type

    No type

    Projects

    Status
    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions