Skip to content

[Experimental] PGM CLI implementation - #1297

Merged
TonyXiang8787 merged 88 commits into
mainfrom
feature/pgm-cli
Oct 22, 2026
Merged

[Experimental] PGM CLI implementation#1297
TonyXiang8787 merged 88 commits into
mainfrom
feature/pgm-cli

Conversation

@TonyXiang8787

@TonyXiang8787 TonyXiang8787 commented Feb 2, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

This PR attempts to implement a PGM command line interface as native executable which links to the C-API. The executable can be invoked in Python as a Python shim.

Check list

Local test guide

Test install

Run the following at any working folder

uv tool install git+https://github.com/PowerGridModel/power-grid-model.git@feature/pgm-cli
power-grid-model --help
power-grid-model --version
uv tool uninstall power-grid-model

Test editable

Checkout this branch, then do a round of build and test.

uv sync --reinstall
uv run pytest
uv run power-grid-model --help
uv run power-grid-model --version

@TonyXiang8787 TonyXiang8787 self-assigned this Feb 2, 2026
@TonyXiang8787 TonyXiang8787 added feature New feature or request do-not-merge This should not be merged temporarily labels Feb 2, 2026
mgovers
mgovers reviewed Feb 2, 2026
View reviewed changes

@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.

i don't have time to do a full review but this is at least some input

Comment thread power_grid_model_c/power_grid_model_c/CMakeLists.txt Outdated
Comment thread power_grid_model_c/power_grid_model_cli_backend/src/cli_options.cpp
Comment thread power_grid_model_c/power_grid_model_cli/main.cpp Outdated
Comment thread power_grid_model_c/CMakeLists.txt
Comment thread src/power_grid_model/_core/power_grid_model_c/run_pgm_cli.py Outdated
Comment thread src/power_grid_model/_core/power_grid_model_c/run_pgm_cli.py
Comment thread src/power_grid_model/_core/power_grid_model_c/run_pgm_cli.py Outdated
Comment thread CMakeLists.txt
@sonarqubecloud

sonarqubecloud Bot commented May 4, 2026

Copy link
Copy Markdown

Quality Gate Failed Quality Gate failed

Failed conditions
78.4% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

@sonarqubecloud

sonarqubecloud Bot commented May 12, 2026

Copy link
Copy Markdown

Quality Gate Failed Quality Gate failed

Failed conditions
77.8% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

github-advanced-security[bot]
github-advanced-security Bot found potential problems Jul 1, 2026
View reviewed changes
Comment thread src/power_grid_model/_core/power_grid_model_c/run_pgm_cli.py Fixed
@TonyXiang8787
CLI experiment with singed commit
bcedee0 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
mgovers and others added 16 commits July 9, 2026 12:56
@mgovers
Merge branch 'main' into feature/pgm-cli
1b0d2f6 
Signed-off-by: Martijn Govers <martijn.govers@alliander.com>
@TonyXiang8787
down merge
ce329a6 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
Merge branch 'main' into feature/pgm-cli
9f0e593
@TonyXiang8787
Merge branch 'main' into feature/pgm-cli
63b2c0e
@TonyXiang8787
Remove GitHub release job from workflow
13e1f18 
Removed the GitHub release job from the CI workflow.

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
help cli
3b2548f 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
try sign
d9b2015 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
Merge branch 'main' into feature/pgm-cli
10ae34f
@TonyXiang8787
try to split
aaa70c0 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
reuse python shim
417b17b 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
add mutex
fc99c28 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
call back
532316a 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
message call back
21fd9c3 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
get cli test
bccf944 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
cli test
0e090a4 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
test more
dd4c74a 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
use c
b919bac 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
test shim
42eb6ce 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
Update test target file path for PGMCLI
0899a7d 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
doc in toml
723f09e 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
add empty tables
8487ce4 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
verbose to show
29c496d 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
use new env
a6788b3 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
try again with conda
0232ffa 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
mgovers
mgovers reviewed Oct 21, 2026
View reviewed changes

@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.

looks really good already. Couple minor comments remaining.

Comment thread power_grid_model_c/power_grid_model_cli_backend/src/cli_options.cpp
Comment thread power_grid_model_c/power_grid_model_cli_backend/src/cli_options.cpp Outdated
Comment thread power_grid_model_c/power_grid_model_cli_backend/src/cli_options.cpp
Comment thread power_grid_model_c/power_grid_model_cli_backend/src/cli_options.cpp
Comment thread power_grid_model_c/power_grid_model_cli_backend/CMakeLists.txt Outdated
Comment thread power_grid_model_c/power_grid_model_cli_backend/src/cli_main.cpp Outdated
Comment thread power_grid_model_c/power_grid_model_cli/CMakeLists.txt Outdated
Comment thread docs/advanced_documentation/build-guide.md Outdated
Comment thread .github/workflows/build-test-release.yml Outdated
Comment thread power_grid_model_c/power_grid_model_cli/main.cpp
TonyXiang8787 and others added 13 commits October 21, 2026 12:04
@TonyXiang8787 @mgovers
Update CMakeLists.txt
de66550 
Co-authored-by: Martijn Govers <martijn.govers@alliander.com>
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787 @mgovers
Update CMakeLists.txt
3b968e9 
Co-authored-by: Martijn Govers <martijn.govers@alliander.com>
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787 @mgovers
Update docs/advanced_documentation/build-guide.md
a0bd2ac 
Co-authored-by: Martijn Govers <martijn.govers@alliander.com>
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787 @mgovers
Update power_grid_model_c/power_grid_model_cli_backend/src/cli_option…
edf67f1 
…s.cpp

Co-authored-by: Martijn Govers <martijn.govers@alliander.com>
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787 @mgovers
Update power_grid_model_c/power_grid_model_cli_backend/src/cli_main.cpp
f8b5fd4 
Co-authored-by: Martijn Govers <martijn.govers@alliander.com>
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787 @mgovers
Update power_grid_model_c/power_grid_model_cli_backend/src/cli_option…
37811e8 
…s.cpp

Co-authored-by: Martijn Govers <martijn.govers@alliander.com>
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787 @mgovers
Update power_grid_model_c/power_grid_model_cli_backend/src/cli_option…
a5455a3 
…s.cpp

Co-authored-by: Martijn Govers <martijn.govers@alliander.com>
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
fix typo
588cbfb
@TonyXiang8787
Merge branch 'feature/pgm-cli' of git@github.com:PowerGridModel/power…
e470be9 
…-grid-model.git
@TonyXiang8787
fix cmake
f6e7378 
DCO Remediation Commit for Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

I, Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>, hereby add my Signed-off-by to this commit: 588cbfb

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
fix error
7733152 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
revert back to stream
7b7b514 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787
remove vvv
4d288d4 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@TonyXiang8787 TonyXiang8787 mentioned this pull request Oct 21, 2026
Open
1 task
@TonyXiang8787
TonyXiang8787 requested a review from mgovers October 21, 2026 18:45
@TonyXiang8787
add sstream
53b6256 
Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>
@sonarqubecloud

sonarqubecloud Bot commented Oct 21, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
86.5% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@TonyXiang8787
TonyXiang8787 added this pull request to the merge queue Oct 22, 2026
Merged via the queue into main with commit eece729 Oct 22, 2026
60 of 62 checks passed
@TonyXiang8787
TonyXiang8787 deleted the feature/pgm-cli branch October 22, 2026 10:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@figueroa1395 figueroa1395 figueroa1395 left review comments
@mgovers mgovers mgovers approved these changes
+1 more reviewer
@github-advanced-security github-advanced-security[bot] github-advanced-security[bot] left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@TonyXiang8787 TonyXiang8787

Labels

feature New feature or request

Projects

Power Grid Model
Status: No status

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@TonyXiang8787 @mgovers @figueroa1395 @github-advanced-security