Feature: allow passing custom runpp-function to pp.diagnostics

[jthurner]

pp.diagnostic runs power flows during various tests but does not allow passing arguments to pp.runpp.

This PR adds an optional argument runpp_function to pp.diagnostic which takes a function to be used for running power flows. The argument defaults to pp.runpp, existing code is unaffected.

Arguments to pp.runpp can then be passed through pp.diagnostic by supplying a partial as the runpp_function.

[rbolgaryn]

Dear @jthurner ,

thank you for this contribution!

I suggest enabling two features: 1) passing the function to be used instead of runpp and 2) passing kwargs to that function - in a way that either one is possible and you do not need to prepare the partial for the diagnostic function.

e.g.

diagnostic(net, init="results")
diagnostic(net, runpp_function=pp.rundcpp)
diagnostic(net, runpp_function=pp.rundcpp, trafo_loading="power")

Also, I suggest renaming the parameter to "run" to be consistent with the pp.run_timeseries where you can pass the runpp function as the "run" parameter.

[jthurner]

Dear Roman,
the signature should now be consistent with pp.run_timeseries, please check if these changes are what you had in mind.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.44%. Comparing base (f7d0f1c) to head (21fee72).

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #2193   +/-   ##
========================================
  Coverage    79.43%   79.44%           
========================================
  Files          255      255           
  Lines        27947    27952    +5     
========================================
+ Hits         22201    22206    +5     
  Misses        5746     5746           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[rbolgaryn]

Dear @jthurner ,

please update the branch (merge develop) and add a mention of this change to CHANGELOG.

[rbolgaryn]

for some reason I cannot update the branch (usually there is a button "Update branch" but not in this case)

[jthurner]

Merged develop and updated CHANGELOG.

for some reason I cannot update the branch (usually there is a button "Update branch" but not in this case)

Because the fork is under an organization account, I can not grant "Allow edits from maintainers" on the PR (see e.g.
orgs/community#5634). Pretty annoying, we might have to open future PRs from personal branches instead.