Skip to content

Migration guide v5.1.0

Nicolas Rol edited this page Jul 3, 2023 · 6 revisions

Breaking changes

CgmesExportContext.ModelDescription

CgmesExportContext.ModelDescription has been modified. It can now contain several IDs (corresponding to several files, for example during a CGM import). Now use setIds(String...) or addId(String) methods instead of setId(String).

Merging behaviour

Merging behaviour has been modified for CGM import, destructive merging and Merging view creation. For those three, here is what happens:

  • Do not merge dangling lines in a same network
  • If multiple dangling lines on a xnode, merge the connected dangling lines if they are exactly two
  • If multiple connected dangling lines on a xnode, keep them as dangling lines
  • If two dangling lines are created in a merging view within the same underlying network: they are not merged

Migrate to IIDM/XIIDM 1.9

At this release, IIDM has been changed to version 1.9. Consequently, if you are using a XIIDM converter from powsybl-core v5.1.1 and above to write IIDM network files in version 1.9, you should use a XIIDM converter from powsybl-core v5.1.1 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.

For more information about the new features, please read the documentation page on IIDM/IIDM-XML 1.9 evolutions.

SecurityAnalysisResult

OperatorStrategies

Index sensitivity values by variable type

Remove test jars usage

In your pom.xml, replace for example:

<dependency>
   <groupId>com.powsybl</groupId>
   <artifactId>powsybl-commons</artifactId>
   <type>test-jar</type>
   <version>${powsyblcore.version}</version>
</dependency>

with:

<dependency>
   <groupId>com.powsybl</groupId>
   <artifactId>powsybl-commons-test</artifactId>
   <version>${powsyblcore.version}</version>
</dependency>

Replace:

  • import com.powsybl.tools.AbstractToolTest; with import com.powsybl.tools.test.AbstractToolTest;
  • AbstractXmlConverterTest with AbstractConverterTest

Update GraphViz library

Deprecated

Replace noGeneratorReactiveLimits by reactiveLimits in LoadFlowParameters

Replace LoadFlowProvider.getSpecificParametersNames() by LoadFlowProvider.getSpecificParameters()

Clone this wiki locally