Migration guide v3.7.0

CGMES Import uses CgmesSvMetadata extension

An extension named CgmesSvMetadata is now used (and filled) during CGMES Import. In order not to make your CGMES Import fail, please check that the IIDM implementation you are using has an implementation of this extension. If you are using the default in-memory IIDM implementation, no action is required.

Migrate to IIDM/XIIDM 1.4

At this release, IIDM has been changed to version 1.4. For more information about the new features, please read the documentation page about IIDM/IIDM-XML 1.4 evolutions.

API

If you are using a custom implementation of IIDM API (different from the one available in powsybl-iidm-impl), please be sure to update your implementation in order not to throw UnsupportedOperationException when a new method is used.

Serialization

If you are using a XIIDM converter from powsybl-core v3.7.0 and above to write IIDM network files in version 1.4, you should use a XIIDM converter from powsybl-core v3.7.0 to read them as well without issues.

Please note that it is possible to read and write XIIDM files in previous IIDM-XML versions.

In order to write XIIDM files in previous versions (e.g. the version 1.0), you need to use the following configuration property:

import-export-parameters-default-value:
  iidm.export.xml.version: "1.0"

or use the Java object ExportOptions in your parameters with a suitable set version:

... // do something
ExportOptions options = new ExportOptions().setVersion("1.0");
NetworkXml.write(network, options, path);
... // do something

⚠️ Writing XIIDM files in previous versions will only be possible if the network you want to serialize has no new features or has only new features that can be interpreted in the previous versions.

Reading XIIDM files in previous versions does not require any particular configuration.

CGMES Import uses CimCharacteristics extension

An extension named CimCharacteristics is now used (and filled) during CGMES Import. In order not to make your CGMES Import fail, please check that the IIDM implementation you are using has an implementation of this extension. If you are using the default in-memory IIDM implementation, no action is required.

CGMES Import uses SlackTerminal extension

An extension named SlackTerminal is now used (and filled) during CGMES Import. In order not to make your CGMES Import fail, please check that the IIDM implementation you are using has an implementation of this extension. If you are using the default in-memory IIDM implementation, no action is required.

Refactoring of sensitivity analysis API

Entry point of sensitivity analysis has changed. Previously a concrete class SensitivityComputation had to be built from a Network and a ComputationManager for example. By now the final class SensitivityAnalysis is the single entry point of the module on which you can call find method to get an implementation of SensitivityAnalysisProvider on which you can call the run method. For further details you can follow the turorial on sensitivity analysis https://www.powsybl.org/pages/documentation/developer/tutorials/sensitivity-analysis.html

PSS/E options

The ignore-base-voltage option is not supported anymore. As PSS/E converter is an alpha feature, we consider it's not useful to be backward compatible. The new option is psse.import.ignore-base-voltage. Note that the default value of this option has changed from TRUE to FALSE.