Skip to content

Current sensor: remove experimental flag for ILSE #1007

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 5, 2025
Merged

Current sensor: remove experimental flag for ILSE #1007

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d1ccd1d
removed experimental flag for ILSE: api, test, doc
Jerry-Jinfeng-Guo Jun 1, 2025
df04292
missed one warning in doc
Jerry-Jinfeng-Guo Jun 2, 2025
ad4270c
Merge branch 'main' into feature/remove-experimental-flag-ilse-curren…
mgovers Jun 4, 2025
efc62a1
remove experimental feature flag from ILSE validation cases
mgovers Jun 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/user_manual/calculations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ In observable systems this helps better outputting correct results. On the other
```

```{warning}
At the time of writing, the component [current sensor](./components.md#generic-current-sensor) is not supported in the calculation of [Newton-Raphson state estimation](#newton-raphson-state-estimation). The support in the calculation of [Iterative Linear state estimation](#iterative-linear-state-estimation) is experimental.
At the time of writing, the component [current sensor](./components.md#generic-current-sensor) is not supported in the calculation of [Newton-Raphson state estimation](#newton-raphson-state-estimation).
```

##### Necessary observability condition
Expand Down
8 changes: 0 additions & 8 deletions docs/user_manual/components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -863,10 +863,6 @@ $$

### Generic Current Sensor

```{warning}
At the time of writing, this feature is still experimental and is not yet publicly available.
```

```{warning}
At the time of writing, state estimation with current sensors is not supported by the Newton-Raphson calculation method.
```
Expand Down Expand Up @@ -898,10 +894,6 @@ However, such mixing of sensor types is allowed as long as they are on different

#### Current Sensor Concrete Types

```{warning}
At the time of writing, this feature is still experimental and is not yet publicly available.
```

```{warning}
At the time of writing, state estimation with current sensors is not supported by the Newton-Raphson calculation method.
```
Expand Down
8 changes: 3 additions & 5 deletions power_grid_model_c/power_grid_model/include/power_grid_model/main_model_impl.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -803,11 +803,9 @@ class MainModelImpl<ExtraRetrievableTypes<ExtraRetrievableType...>, ComponentLis

void check_no_experimental_features_used(Options const& options) const {
if (options.calculation_type == CalculationType::state_estimation &&
state_.components.template size<GenericCurrentSensor>() > 0) {
if (options.calculation_method == CalculationMethod::newton_raphson) {
throw ExperimentalFeature{"Newton-Raphson state estimation is not implemented for current sensors"};
}
throw ExperimentalFeature{"State estimation with current sensors is experimental"};
state_.components.template size<GenericCurrentSensor>() > 0 &&
options.calculation_method == CalculationMethod::newton_raphson) {
throw ExperimentalFeature{"Newton-Raphson state estimation is not implemented for current sensors"};
}
}

Expand Down
3 changes: 0 additions & 3 deletions tests/data/state_estimation/current-sensor/global-current-sensor/params.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,6 @@
".+_residual": 5e-4
},
"extra_params": {
"iterative_linear": {
"experimental_features": "enabled"
},
"newton_raphson": {
"experimental_features": "enabled",
"fail": {
Expand Down
3 changes: 0 additions & 3 deletions tests/data/state_estimation/current-sensor/local-current-sensor/params.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,6 @@
".+_residual": 5e-4
},
"extra_params": {
"iterative_linear": {
"experimental_features": "enabled"
},
"newton_raphson": {
"experimental_features": "enabled",
"fail": {
Expand Down
5 changes: 2 additions & 3 deletions tests/native_api_tests/test_api_model.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1063,7 +1063,7 @@ TEST_CASE("API Model") {
}
}

SUBCASE("Current sensor is experimental") {
SUBCASE("Current sensor for NRSE is experimental: not implemented") {
auto const input_data_se_json = R"json({
"version": "1.0",
"type": "input",
Expand Down Expand Up @@ -1103,8 +1103,7 @@ TEST_CASE("API Model") {
"Newton-Raphson state estimation is not implemented for current sensors",
PowerGridRegularError);
} else {
CHECK_THROWS_WITH_AS(run_se_with_current_sensor(method, PGM_experimental_features_disabled),
"State estimation with current sensors is experimental", PowerGridRegularError);
CHECK_NOTHROW(run_se_with_current_sensor(method, PGM_experimental_features_disabled));
}
CHECK_NOTHROW(run_se_with_current_sensor(method, PGM_experimental_features_enabled));
}
Expand Down
5 changes: 2 additions & 3 deletions tests/unit/test_error_handling.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
LoadGenType,
MeasuredTerminalType,
TapChangingStrategy,
_ExperimentalFeatures,
)
from power_grid_model.errors import (
AutomaticTapInputError,
Expand Down Expand Up @@ -422,7 +421,7 @@ def test_conflicting_angle_measurement_type() -> None:
)

with pytest.raises(ConflictingAngleMeasurementType):
model._calculate_state_estimation(decode_error=True, experimental_features=_ExperimentalFeatures.enabled)
model._calculate_state_estimation(decode_error=True)


def test_global_current_measurement_without_voltage_angle() -> None:
Expand Down Expand Up @@ -470,7 +469,7 @@ def test_global_current_measurement_without_voltage_angle() -> None:
)

with pytest.raises(NotObservableError):
model._calculate_state_estimation(decode_error=True, experimental_features=_ExperimentalFeatures.enabled)
model._calculate_state_estimation(decode_error=True)


@pytest.mark.skip(reason="TODO")
Expand Down
Loading