Migration guide v4.1.0

Deletion of simulation-api module

From this version, simulation-api module will be removed. Please use dynamic-simulation-api module instead.

Import of CGMES Control Area

From this version, CGMES control area and area exchanges are imported in IIDM model. If you are using a custom IIDM implementation, you will then need to implement the new extension CgmesControlAreas and its adder and sub-object. Don't forget to implement a provider for your custom extension adder implementation.

Boundaries have also been extended for this feature. It will still work to an extent if you do not implement the newly added methods, however some information will be missing. Please implement them to ensure a correct import.

Export of CGMES node-breaker networks and creating of CGMES-IIDM bus mapping

In order to make CGMES node-breaker networks export possible, a CGMES-IIDM bus mapping must be created. If you are using a custom IIDM implementation, you will then need to implement the new extension CgmesIidmMapping and its adder to use this feature. Don't forget to implement a provider for your custom extension adder implementation.

Import, load flow and sensitivity analysis additional APIs

If you use import, load flow or sensitivity analysis APIs, you should now add a new dependency on powsybl-commons artifact. Indeed, new APIs have been introduced for the functional logs beta feature, which requires this new dependency. Note that the existing APIs are still there and are not marked as deprecated yet, as this is still a beta-feature.

Functional logs beta feature

A beta-feature for functional logging has been added in this version by PR #1666. The corresponding Reporter API can be found in powsybl-commons artifact, in the com.powsybl.commons.reporter package. A default implementation ReporterModel is provided in the same package. Documentation on this beta feature and how to use it will soon be available on powsybl website. In the meantime, you could have a look at the corresponding javadoc.