[Release] v1.8.0

[mgovers]

• Make automatic tap changer not experimental anymore
• Bump version

Preview of release notes (full changelog to be re-generated)

Highlights

• ✅ Added support for power flow calculations with automatic tap changing (see the documentation)
• ✅ Added observability checks for state estimation (see the documentation)
• ✅ Added support for separate error types in the Python interface (see the documentation)
• 💥 Multiple bugfixes (e.g., see #554 and #635)
• 🚀 Improve stability of Newton-Raphson power flow calculations (see #549)
• 🚀 Improvements and fixes to documentation.
• 🎉 Various improvements to the internal implementation and compiler support.

What's Changed

• fix Documentation of calculation of y_base by @Welthulk in fix Documentation of calculation of y_base #496
• Feature/optimize headers by @mgovers in Feature/optimize headers #502
• extra trafo getters by @petersalemink95 in extra trafo getters #507
• Feature/nrse example by @zhen0427 in Feature/nrse example #506
• Feature/Updated validation to allow for missing sigma by @Jerry-Jinfeng-Guo in Feature/Updated validation to allow for missing sigma #503
• Bump fsfe/reuse-action from 2 to 3 by @dependabot in Bump fsfe/reuse-action from 2 to 3 #511
• Feature/tags as template args by @mgovers in Feature/tags as template args #512
• Feature/remove rl logic by @zhen0427 in Feature/remove rl logic #510
• NRPF improvement: change real to complex calculation in Jacobian by @nitbharambe in NRPF improvement: change real to complex calculation in Jacobian #513
• Enhanced documentation on batch datasets by @zhen0427 in Enhanced documentation on batch datasets  #514
• Changed the datatype of indptr from int32/'integer' to int64 by @Jerry-Jinfeng-Guo in Changed the datatype of indptr from int32/'integer' to int64 #518
• Fix MacOS CI setup phase by @mgovers in Fix MacOS CI setup phase #522
• Bump softprops/action-gh-release from 1 to 2 by @dependabot in Bump softprops/action-gh-release from 1 to 2 #519
• Quick patch on remaining issues on the docs. by @Jerry-Jinfeng-Guo in Quick patch on remaining issues on the docs. #521
• bump gcc in CI to 13 to test faster compilation by @mgovers in bump gcc in CI to 13 to test faster compilation #520
• [Bugfix] workaround ASAN issues on latest github runner images by @mgovers in [Bugfix] workaround ASAN issues on latest github runner images #531
• add merge queue stuff for CI by @mgovers in add merge queue stuff for CI #532
• Add an example notebook of transformers. by @zhen0427 in Add an example notebook of transformers. #524
• Necessary conditions for observability by @nitbharambe in Necessary conditions for observability #523
• Sorting optimization by @Laurynas-Jagutis in Sorting optimization #504
• Bump pypa/cibuildwheel from 2.16.5 to 2.17.0 by @dependabot in Bump pypa/cibuildwheel from 2.16.5 to 2.17.0 #535
• add DCO for merge groups by @mgovers in add DCO for merge groups #536
• Refresh SE notebook for observability by @nitbharambe in Refresh SE notebook for observability #538
• Fix/General re-touching of the documentation by @Jerry-Jinfeng-Guo in Fix/General re-touching of the documentation #539
• separate test executable for quickly compilable unit tests and long by @mgovers in separate test executable for quickly compilable unit tests and long #544
• Feature/auto tap changer skeleton by @mgovers in Feature/auto tap changer skeleton #543
• Regulator class for automatic tap changer by @petersalemink95 in Regulator class for automatic tap changer #534
• Preparing steps 2-3 so that step 1 can start by @Jerry-Jinfeng-Guo in Preparing steps 2-3 so that step 1 can start #550
• Initialize NRPF with with linear pf by @nitbharambe in Initialize NRPF with with linear pf #549
• Feature/separate python error types by @mgovers in Feature/separate python error types #546
• catch not observable exception for base scenario by @nitbharambe in catch not observable exception for base scenario #551
• Feature/Transformer ranking - Step 2-3 by @Jerry-Jinfeng-Guo in Feature/Transformer ranking - Step 2-3 #545
• add test test case for state estimation bug [BUG] State Estimation batch calculations fail in certain cases #554 by @mgovers in add test test case for state estimation bug #554 #555
• Update branch by @Jerry-Jinfeng-Guo in Update branch #556
• documentation for error types by @mgovers in documentation for error types #552
• also run macos arm64 in merge group by @mgovers in also run macos arm64 in merge group #553
• revert 531 by @TonyXiang8787 in revert 531 #561
• Feature/transformer ranking step 4 by @Jerry-Jinfeng-Guo in Feature/transformer ranking step 4 #558
• Clang-tidy -misc-include-cleaner option by @Jerry-Jinfeng-Guo in Clang-tidy -misc-include-cleaner option #563
• Use GitHub hosted runner macos-14 for macOS build by @TonyXiang8787 in Use GitHub hosted runner macos-14 for macOS build #566
• refactor main core + initial setup for tap regulator input/output by @mgovers in refactor main core + initial setup for tap regulator input/output #565
• Unit tests for transformer ranking by @Jerry-Jinfeng-Guo in Unit tests for transformer ranking #567
• Feature/transformer ranking test 1 by @Jerry-Jinfeng-Guo in Feature/transformer ranking test 1 #569
• Added size checks before retrieve_info; updated the test by @Jerry-Jinfeng-Guo in Added size checks before retrieve_info; updated the test #570
• Bump dieghernan/cff-validator from 2.3 to 3 by @dependabot in Bump dieghernan/cff-validator from 2.3 to 3 #571
• [Feature] common state queries + transformer concept by @mgovers in [Feature] common state queries + transformer concept #572
• Transformer edge fix by @Jerry-Jinfeng-Guo in Transformer edge fix #573
• run citations workflow when current workflow changes by @mgovers in run citations workflow when current workflow changes #575
• Transformer ranking part 1 by @nitbharambe in Transformer ranking part 1  #562
• [FEATURE] add support for same-ranked transformers by @mgovers in [FEATURE] add support for same-ranked transformers #577
• Feature/container + main core improvements by @mgovers in Feature/container + main core improvements #578
• Use NaN as default value in input/output/update struct by @TonyXiang8787 in Use NaN as default value in input/output/update struct #579
• Tap position optimizer outer loop by @mgovers in Tap position optimizer outer loop #557
• fix missed checkin by @mgovers in fix missed checkin #581
• Renaming MathOutput to SolverOutput by @Jerry-Jinfeng-Guo in Renaming MathOutput to SolverOutput #583
• [FEATURE] migrate to miniforge by @mgovers in [FEATURE] migrate to miniforge #584
• Feature/tap optimize voltage level tests by @mgovers in Feature/tap optimize voltage level tests #586
• New generic MathOutput to include both SolverOutput and OptimizerOutput by @Jerry-Jinfeng-Guo in New generic MathOutput to include both SolverOutput and OptimizerOutput #585
• fix performance regression by @mgovers in fix performance regression #592
• automatic tap changer outer loop multiple transformer test by @nitbharambe in automatic tap changer outer loop multiple transformer test #590
• [Feature] elaborate null in JSON and nil in msgpack schemas by @mgovers in [Feature] elaborate null in JSON and nil in msgpack schemas #591
• Bump pypa/cibuildwheel from 2.17.0 to 2.18.0 by @dependabot in Bump pypa/cibuildwheel from 2.17.0 to 2.18.0 #593
• add retry logic when tap optimizer diverges by @mgovers in add retry logic when tap optimizer diverges #589
• Feature/line drop compensation tests by @mgovers in Feature/line drop compensation tests #588
• Feature/default build by @mgovers in Feature/default build #596
• [Feature] migrate gcc-13 by @mgovers in [Feature] migrate gcc-13 #600
• Feature/cleaner cpp api integration by @mgovers in Feature/cleaner cpp api integration #599
• [Feature] Automatic Tap Changer C API by @mgovers in [Feature] Automatic Tap Changer C API #597
• try gcc 12 in the ci by @TonyXiang8787 in try gcc 12 in the ci #603
• [Feature] enable Python API for auto tap changer (experimental) by @mgovers in [Feature] enable Python API for auto tap changer (experimental) #604
• [Feature] tap regulator output data declaration by @mgovers in [Feature] tap regulator output data declaration #605
• Feature/tap regulator output by @mgovers in Feature/tap regulator output #607
• pgm-automatic-tap validation tests by @nitbharambe in pgm-automatic-tap validation tests #602
• feature/update main model for automatic tap changer by @Jerry-Jinfeng-Guo in feature/update main model for automatic tap changer #598
• Feature/auto tap validation test by @mgovers in Feature/auto tap validation test #608
• Bump pypa/cibuildwheel from 2.18.0 to 2.18.1 by @dependabot in Bump pypa/cibuildwheel from 2.18.0 to 2.18.1 #609
• [Feature] support auto tap when node ids do start at 0 by @mgovers in [Feature] support auto tap when node ids do start at 0 #611
• [Feature] - set line drop compensation to 0 by default by @mgovers in [Feature] - set line drop compensation to 0 by default #612
• automatic tap changer regulation tactic validation cases by @nitbharambe in automatic tap changer regulation tactic validation cases #610
• Feature/remove legacy dataset by @TonyXiang8787 in Feature/remove legacy dataset #587
• Automatic tap changer line drop validation tests by @nitbharambe in Automatic tap changer line drop validation tests #616
• feature/maximum iteration per rank to prevent infinite loop by @Jerry-Jinfeng-Guo in feature/maximum iteration per rank to prevent infinite loop #614
• [Feature] add automatic tap adjustment to the transformer notebook by @mgovers in [Feature] add automatic tap adjustment to the transformer notebook #615
• [Feature] Automatic tap changer documentation by @mgovers in [Feature] Automatic tap changer documentation #606
• [Feature] make tap regulator input attributes always required by @mgovers in [Feature] make tap regulator input attributes always required #618
• temporarily remove clang cl from CI by @mgovers in temporarily remove clang cl from CI #629
• temporarily add DCO check by @mgovers in temporarily add DCO check #625
• Adding new colleague to the maintainer's list by @Jerry-Jinfeng-Guo in Adding new colleague to the maintainer's list #623
• Feature / State restoration after exception in optimizer by @Jerry-Jinfeng-Guo in Feature / State restoration after exception in optimizer #617
• tap regulator data validation required check by @nitbharambe in tap regulator data validation required check #624
• [FEATURE] Auto tap uband recommendation by @nitbharambe in [FEATURE] Auto tap uband recommendation #619
• Editing error handling in PF Example notebook. by @zhen0427 in Editing error handling in PF Example notebook. #628
• [FEATURE] basic validation checks for tap regulator by @mgovers in [FEATURE] basic validation checks for tap regulator #620
• Reconfigure cmake preset by @TonyXiang8787 in Reconfigure cmake preset #622
• test without clang-cl override by @mgovers in test without clang-cl override #633
• Revert "temporarily add DCO check" by @mgovers in Revert "temporarily add DCO check" #632
• change pre-commit config .yaml file by @zhen0427 in change pre-commit config .yaml file #627
• [Fix] handle nullptr on serialization error by @mgovers in [Fix] handle nullptr on serialization error #635
• fix sonar coverage by @TonyXiang8787 in fix sonar coverage #636
• Feature/validation check control side tap by @mgovers in Feature/validation check control side tap #634
• [Release] v1.8.0 by @mgovers in [Release] v1.8.0 #637

New Contributors

• @Welthulk made their first contribution in fix Documentation of calculation of y_base #496

Full Changelog: v1.7.0...v1.8.0

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
11.1% Duplication on New Code

See analysis details on SonarCloud

[Jerry-Jinfeng-Guo]

Is this PR ready to be approved? Interesting to see the Newton Raphson in extra params still got exp features?

[mgovers]

Is this PR ready to be approved? Interesting to see the Newton Raphson in extra params still got exp features?

Yes it is ready for approval.

The ones that were marked experimental were all related to auto tap