Skip to content

[IMPROVEMENT] update examples and docs for Power Grid Meta Data attributes enum#1336

Merged
figueroa1395 merged 18 commits intoPowerGridModel:mainfrom
furqan463:attribute_type_docs
Mar 24, 2026
Merged

[IMPROVEMENT] update examples and docs for Power Grid Meta Data attributes enum#1336
figueroa1395 merged 18 commits intoPowerGridModel:mainfrom
furqan463:attribute_type_docs

Conversation

@furqan463
Copy link
Copy Markdown
Contributor

@furqan463 furqan463 commented Mar 19, 2026 •
edited
Loading

Fixes #949

Changes proposed in this PR include:

AttributeType introduced in #1324 , however, examples were not updated accordingly. This PR is a follow up of PR #1324

Checks

  • All examples fully updated with AttributeType
  • Review docs

@furqan463
Update asymmetric calculation example
53e5a05 
Signed-off-by: furqan463 <ahmadfurqanc@gmail.com>
@furqan463
Update Asymmetric Line
8706449 
Signed-off-by: furqan463 <ahmadfurqanc@gmail.com>
@furqan463
Update generic branch
f4d389f 
Signed-off-by: furqan463 <ahmadfurqanc@gmail.com>
@furqan463
Update make_test_dataset
6cd2272 
Signed-off-by: furqan463 <ahmadfurqanc@gmail.com>
@furqan463
Update multi-dimentional_batch_cal
6d8e1a6 
Signed-off-by: furqan463 <ahmadfurqanc@gmail.com>
@furqan463
Update power_flow_example
b7ccbbd 
Signed-off-by: furqan463 <ahmadfurqanc@gmail.com>
@furqan463
Update Serialization_example
363d1e2 
Signed-off-by: furqan463 <ahmadfurqanc@gmail.com>
@furqan463
Update short_circuit_example
22c295e 
Signed-off-by: furqan463 <ahmadfurqanc@gmail.com>
@furqan463
Update steate_estimation
6b17d29 
Signed-off-by: furqan463 <ahmadfurqanc@gmail.com>
furqan463
furqan463 commented Mar 19, 2026
View reviewed changes
@furqan463
Update transformer_examples
cbbc3d8 
Signed-off-by: furqan463 <ahmadfurqanc@gmail.com>
@furqan463
Update validation_examples
d241b68 
Signed-off-by: furqan463 <ahmadfurqanc@gmail.com>
@furqan463
Fix formatting
da615f8 
Signed-off-by: furqan463 <ahmadfurqanc@gmail.com>
@furqan463
Update example descriptions
aaa931d 
Signed-off-by: furqan463 <ahmadfurqanc@gmail.com>
@furqan463
Update dataset-terminology
9c8e8bb 
Signed-off-by: furqan463 <ahmadfurqanc@gmail.com>
@furqan463
Copy link
Copy Markdown
Contributor Author

furqan463 commented Mar 19, 2026

@figueroa1395 I've updated the docs/user_manual/dataset-terminology.md file, can you please review it. also in docs/user_manual/components.md do we want to change all attribute names with AttributeType?
Once we agree on the extent to update docs, I'll thoroughly review all the docs and make the changes. Thanks.

@figueroa1395 figueroa1395 added the documentation Improvements or additions to documentation label Mar 19, 2026
@figueroa1395
Copy link
Copy Markdown
Member

figueroa1395 commented Mar 19, 2026

@figueroa1395 I've updated the docs/user_manual/dataset-terminology.md file, can you please review it. also in docs/user_manual/components.md do we want to change all attribute names with AttributeType? Once we agree on the extent to update docs, I'll thoroughly review all the docs and make the changes. Thanks.

Hello @furqan463,

thanks for the quick follow up PR. I will review as soon as I can. In the meantime, I've assigned this to you and added the respective labels.

figueroa1395
figueroa1395 reviewed Mar 23, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@figueroa1395 figueroa1395 left a comment

Choose a reason for hiding this comment

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

Some minor remarks. But in general looks good to me. Now it's mostly to address the documentation and follow up on the few things I pointed out in the examples.

@furqan463
Restore dataset-terminology changes
07482a7 
Signed-off-by: furqan463 <ahmadfurqanc@gmail.com>
@furqan463
Update docs
d032021 
Signed-off-by: furqan463 <ahmadfurqanc@gmail.com>
@furqan463 furqan463 requested a review from figueroa1395 March 24, 2026 05:04
figueroa1395
figueroa1395 reviewed Mar 24, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@figueroa1395 figueroa1395 left a comment

Choose a reason for hiding this comment

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

Last minor remaining remarks:

  1. Regarding the documentation, there are a few instances at native_data_interface.md that are left to migrate.
  2. I also noticed that in all utils.py files, as well as in _rules.py, there are some instances yet to be migrated.

Once the above two are done, this is good to merge.

@figueroa1395 figueroa1395 added the improvement Improvement on internal implementation label Mar 24, 2026
@furqan463
Copy link
Copy Markdown
Contributor Author

furqan463 commented Mar 24, 2026

  1. Regarding the documentation, there are a few instances at native_data_interface.md that are left to migrate.

Done.

@furqan463
Apply suggestions from Figueroa
833ead7 
Signed-off-by: furqan463 <ahmadfurqanc@gmail.com>
@furqan463
Copy link
Copy Markdown
Contributor Author

furqan463 commented Mar 24, 2026

2. I also noticed that in all utils.py files, as well as in _rules.py, there are some instances yet to be migrated.

Done.

@furqan463 furqan463 requested a review from figueroa1395 March 24, 2026 07:56
@figueroa1395 figueroa1395 enabled auto-merge March 24, 2026 08:49
@figueroa1395 figueroa1395 mentioned this pull request Mar 24, 2026
Closed
3 tasks
@figueroa1395 figueroa1395 added this pull request to the merge queue Mar 24, 2026
Merged via the queue into PowerGridModel:main with commit cff8803 Mar 24, 2026
29 checks passed
@furqan463 furqan463 deleted the attribute_type_docs branch March 24, 2026 09:58
@furqan463 furqan463 mentioned this pull request Mar 27, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@figueroa1395 figueroa1395 figueroa1395 approved these changes

Assignees

@furqan463 furqan463

Labels

documentation Improvements or additions to documentation improvement Improvement on internal implementation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[FEATURE] Power Grid Meta Data attributes enum

2 participants

@furqan463 @figueroa1395