[Experimental] PGM CLI implementation by TonyXiang8787 · Pull Request #1297 · PowerGridModel/power-grid-model

TonyXiang8787 · 2026-02-02T14:20:13Z

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

mgovers

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

sonarqubecloud · 2026-05-04T07:32:20Z

Quality Gate failed

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

See analysis details on SonarQube Cloud

sonarqubecloud · 2026-05-12T15:18:57Z

Quality Gate failed

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

See analysis details on SonarQube Cloud

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

Signed-off-by: Martijn Govers <martijn.govers@alliander.com>

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

Removed the GitHub release job from the CI workflow. Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

figueroa1395

Some initial comments/questions

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

figueroa1395

Some additional things:

I tested the CLI locally on Mac and it works for me.
Should we consider running the validation tests cases via the CLI in the nightly (or weekly or whatever)? Probably as a follow up if yes.

figueroa1395 · 2026-10-16T10:20:28Z

You forgot to add cli-11 to the MacOS build guide on the package installation part.

Also, should we mention somewhere that after uv sync one can just do uv run power-grid-model -h for the CLI? Or is it obvious?

figueroa1395 · 2026-10-16T10:29:07Z

+                {"minimum", PGM_short_circuit_voltage_scaling_minimum},
+                {"maximum", PGM_short_circuit_voltage_scaling_maximum},


"min" and "max" instead?

figueroa1395 · 2026-10-16T10:30:36Z

+    app.add_option("--oc,--output-component", output_components,
+                   "Filter output to only include specified components (can be specified multiple times)");
+    std::vector<std::string> output_attributes;
+    app.add_option("--oa,--output-attribute", output_attributes,


"--oa" and "--oc" maybe a bit much?

figueroa1395 · 2026-10-16T10:39:05Z

+    app.add_option("-i,--input", options.input_file, "Input file path")->required()->check(CLI::ExistingFile);
+    app.add_option("-b,--batch-update", options.batch_update_file,
+                   "Batch update file path. Can be specified multiple times.\n"
+                   "If multiple files are specified, the core will intepret them as the cartesian product of all "


"core" is jargon

Suggested change

"If multiple files are specified, the core will intepret them as the cartesian product of all "

"If multiple files are specified, it will interpret them as the cartesian product of all "

figueroa1395 · 2026-10-16T10:39:55Z

+            },
+            CLI::ignore_case));
+    app.add_flag("--sym,--symmetric-calculation,!--asym,!--asymmetric-calculation", options.symmetric_calculation,
+                 "Use symmetric calculation (1) or not (0)");


What does the 0 and 1 explanation mean? It's confusing.

figueroa1395 · 2026-10-16T10:40:53Z

+            CLI::ignore_case));
+    app.add_flag("--sym,--symmetric-calculation,!--asym,!--asymmetric-calculation", options.symmetric_calculation,
+                 "Use symmetric calculation (1) or not (0)");
+    app.add_option("--error-tolerance", options.error_tolerance, "Error tolerance for iterative calculations");


Mention that the tolerance is in p.u.?

figueroa1395 · 2026-10-16T12:08:32Z

In https://power-grid-model--1297.org.readthedocs.build/en/1297/api_reference/cli-reference.html, the numbers referring to the options aren't organized, we should probably organize them so the should like

--calculation-method ENUM:value in {default->-128,iec60909->newton_raphson->1,iterative_linear->2,iterative_current->3,,linear_current->4,iec60909->5} OR {-128,1,2,3,4,5}

instead of

--calculation-method ENUM:value in {default->-128,iec60909->5,iterative_current->3,iterative_linear->2,linear_current->4,newton_raphson->1} OR {-128,5,3,2,4,1}

This is just one example but something similar happens with most.

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

sonarqubecloud · 2026-10-16T18:18:28Z

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 self-assigned this Feb 2, 2026

TonyXiang8787 added this to Power Grid Model Feb 2, 2026

TonyXiang8787 added feature New feature or request do-not-merge This should not be merged temporarily labels Feb 2, 2026

mgovers reviewed Feb 2, 2026

View reviewed changes

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

CLI experiment with singed commit

bcedee0

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

TonyXiang8787 force-pushed the feature/pgm-cli branch from 266f4e8 to bcedee0 Compare July 1, 2026 14:52

mgovers and others added 16 commits July 9, 2026 12:56

Merge branch 'main' into feature/pgm-cli

1b0d2f6

Signed-off-by: Martijn Govers <martijn.govers@alliander.com>

down merge

ce329a6

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

Merge branch 'main' into feature/pgm-cli

9f0e593

Merge branch 'main' into feature/pgm-cli

63b2c0e

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>

help cli

3b2548f

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

try sign

d9b2015

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

Merge branch 'main' into feature/pgm-cli

10ae34f

try to split

aaa70c0

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

reuse python shim

417b17b

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

add mutex

fc99c28

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

call back

532316a

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

message call back

21fd9c3

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

get cli test

bccf944

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

cli test

0e090a4

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

test more

dd4c74a

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

TonyXiang8787 force-pushed the feature/pgm-cli branch from 0571786 to dd4c74a Compare July 22, 2026 20:29

TonyXiang8787 added 3 commits July 22, 2026 22:30

use c

b919bac

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

test shim

42eb6ce

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

Update test target file path for PGMCLI

0899a7d

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

TonyXiang8787 added 5 commits August 19, 2026 10:23

Merge branch 'main' into feature/pgm-cli

104c70e

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

Merge branch 'main' into feature/pgm-cli

bd7f158

Merge branch 'main' into feature/pgm-cli

2fea14d

trigger ci

47f4a86

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

Merge branch 'main' into feature/pgm-cli

2c17bd2

TonyXiang8787 removed the do-not-merge This should not be merged temporarily label Sep 15, 2026

TonyXiang8787 added 7 commits September 15, 2026 14:13

Merge branch 'main' into feature/pgm-cli

9a689eb

Merge branch 'main' into feature/pgm-cli

966b155

Merge branch 'main' into feature/pgm-cli

fc934dd

Merge branch 'main' into feature/pgm-cli

05d0cac

start docs

3e9b45c

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

docs

eb3291a

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

fix name

1812083

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

figueroa1395 reviewed Oct 5, 2026

View reviewed changes

TonyXiang8787 added 7 commits October 6, 2026 14:24

Merge branch 'main' into feature/pgm-cli

5250946

Merge branch 'main' into feature/pgm-cli

6f55d49

use std format

1bf768d

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

msgpack check comment

ec0695b

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

add user doc

2444fc2

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

add build guide

12f6e7c

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

remove shorthand for many options

41aae17

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

TonyXiang8787 marked this pull request as ready for review October 12, 2026 10:52

TonyXiang8787 added 4 commits October 12, 2026 13:00

explain mutex:'

9934062

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

add initialization

0e3a08d

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

more explanation

e7cc31f

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

fix typo

24114ad

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

figueroa1395 reviewed Oct 16, 2026

View reviewed changes

TonyXiang8787 added 2 commits October 16, 2026 20:06

typo

7e4a73b

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

typo cli option

6e8ab9a

Signed-off-by: Tony Xiang <19280867+TonyXiang8787@users.noreply.github.com>

		{"minimum", PGM_short_circuit_voltage_scaling_minimum},
		{"maximum", PGM_short_circuit_voltage_scaling_maximum},

	"If multiple files are specified, the core will intepret them as the cartesian product of all "
	"If multiple files are specified, it will interpret them as the cartesian product of all "

Conversation

TonyXiang8787 commented Feb 2, 2026 • edited by figueroa1395 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Check list

Local test guide

Test install

Test editable

Uh oh!

mgovers left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented May 4, 2026

Quality Gate failed

Uh oh!

sonarqubecloud Bot commented May 12, 2026

Quality Gate failed

Uh oh!

Uh oh!

figueroa1395 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

figueroa1395 left a comment

Choose a reason for hiding this comment

Uh oh!

figueroa1395 Oct 16, 2026

Choose a reason for hiding this comment

Uh oh!

figueroa1395 Oct 16, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

figueroa1395 Oct 16, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

figueroa1395 Oct 16, 2026

Choose a reason for hiding this comment

Uh oh!

figueroa1395 Oct 16, 2026

Choose a reason for hiding this comment

Uh oh!

figueroa1395 Oct 16, 2026

Choose a reason for hiding this comment

Uh oh!

figueroa1395 Oct 16, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sonarqubecloud Bot commented Oct 16, 2026

Quality Gate passed

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

TonyXiang8787 commented Feb 2, 2026 •

edited by figueroa1395

Loading