diff --git a/docs/configuration/modules/import-export-parameters-default-value.md b/docs/configuration/modules/import-export-parameters-default-value.md index 8bb6b213..3095cde9 100644 --- a/docs/configuration/modules/import-export-parameters-default-value.md +++ b/docs/configuration/modules/import-export-parameters-default-value.md @@ -3,7 +3,7 @@ title: import-export-parameters-default-value layout: default --- -The `import-export-parameters-default-value` module is an optional module used by the `com.powsybl.iidm.import_.Importers` +The `import-export-parameters-default-value` module is an optional module used by the `com.powsybl.iidm.converter.Importers` class to initialize the parameters passed to configure the importer. This module support 3 different types of properties: - Boolean - String diff --git a/docs/configuration/modules/import.md b/docs/configuration/modules/import.md index c25b838d..db26b9cc 100644 --- a/docs/configuration/modules/import.md +++ b/docs/configuration/modules/import.md @@ -3,7 +3,7 @@ title: import layout: default --- -The `import` module is used by the `com.powsybl.iidm.import_.Importers` class, after a case is loaded. A +The `import` module is used by the `com.powsybl.iidm.converter.Importers` class, after a case is loaded. A [post processor](../../iidm/importer/post-processor/index.md) is a class used to modify a network after its loading: - [GroovyPostProcessor](../../iidm/importer/post-processor/GroovyScriptPostProcessor.md): to run a groovy script - [JavaScriptPostProcessor](../../iidm/importer/post-processor/JavaScriptPostProcessor.md) to run a javascript script @@ -16,7 +16,7 @@ used to list the available implementations. # Optional properties ## postProcessors -The `postProcessors` property is an optional property that defines the list of `com.powsybl.iidm.import_.ImportPostProcessor` +The `postProcessors` property is an optional property that defines the list of `com.powsybl.iidm.converter.ImportPostProcessor` names. The default value of this property is an empty list. # Examples diff --git a/docs/configuration/modules/javaScriptPostProcessor.md b/docs/configuration/modules/javaScriptPostProcessor.md index 26e50a0d..b583f89e 100644 --- a/docs/configuration/modules/javaScriptPostProcessor.md +++ b/docs/configuration/modules/javaScriptPostProcessor.md @@ -3,8 +3,8 @@ title: javaScriptPostProcessor layout: default --- -The `javaScriptPostProcessor` module is used by the `com.powsybl.iidm.import_.JavaScriptPostProcessor` class, which is -an implementation of the `com.powsybl.iidm.import_.ImportPostProcessor` that runs a javascript script after a case is +The `javaScriptPostProcessor` module is used by the `com.powsybl.iidm.converter.JavaScriptPostProcessor` class, which is +an implementation of the `com.powsybl.iidm.converter.ImportPostProcessor` that runs a javascript script after a case is converted to an IIDM network. # Optional properties diff --git a/docs/iidm/exporter/iidm.md b/docs/iidm/exporter/iidm.md index 81267dd3..dc674109 100644 --- a/docs/iidm/exporter/iidm.md +++ b/docs/iidm/exporter/iidm.md @@ -123,6 +123,11 @@ This property is deprecated since v2.4.0. Use the `iidm.export.xml.export-mode` # Maven configuration To support IIDM-XML files, add the following dependencies to the `pom.xml` file. ```xml + + com.powsybl + powsybl-iidm-api + ${powsybl.version} + com.powsybl powsybl-iidm-xml-converter diff --git a/docs/iidm/exporter/index.md b/docs/iidm/exporter/index.md index 8ccb656d..00ef0d0d 100644 --- a/docs/iidm/exporter/index.md +++ b/docs/iidm/exporter/index.md @@ -3,7 +3,7 @@ title: Exporters layout: default --- -The `com.powsybl.iidm.export.Exporter` class is used to serialize a IIDM network to files. Powsybl supports natively +The `com.powsybl.iidm.converter.Exporter` class is used to serialize a IIDM network to files. Powsybl supports natively several implementations: - [IIDM](iidm.md) - [AMPL](ampl.md) diff --git a/docs/iidm/importer/cgmes.md b/docs/iidm/importer/cgmes.md index f04c07e7..0c91df2c 100644 --- a/docs/iidm/importer/cgmes.md +++ b/docs/iidm/importer/cgmes.md @@ -66,7 +66,7 @@ To support CGMES files, add the following dependencies to the `pom.xml` file: ```xml com.powsybl - powsybl-cgmes-conversion + powsybl-cgmes-converter ${powsybl.version} diff --git a/docs/iidm/importer/iidm.md b/docs/iidm/importer/iidm.md index b35fb865..8e33d4e5 100644 --- a/docs/iidm/importer/iidm.md +++ b/docs/iidm/importer/iidm.md @@ -107,6 +107,11 @@ The `throwExceptionIfExtensionNotFound` property is deprecated since v2.0.0. Use # Maven configuration To support IIDM-XML files, add the following dependencies to the `pom.xml` file. ```xml + + com.powsybl + powsybl-iidm-api + ${powsybl.version} + com.powsybl powsybl-iidm-xml-converter diff --git a/docs/iidm/importer/index.md b/docs/iidm/importer/index.md index 34fa0bbc..542ca762 100644 --- a/docs/iidm/importer/index.md +++ b/docs/iidm/importer/index.md @@ -3,7 +3,7 @@ title: Importers layout: default --- -The `com.powsybl.iidm.import_.Importer` class is used to create a IIDM network instance from a case. Powsybl supports +The `com.powsybl.iidm.converter.Importer` class is used to create a IIDM network instance from a case. Powsybl supports natively several implementations: - [IIDM](iidm.md) - [CGMES](cgmes.md) diff --git a/docs/iidm/importer/post-processor/GroovyScriptPostProcessor.md b/docs/iidm/importer/post-processor/GroovyScriptPostProcessor.md index 87af5e61..9e391394 100644 --- a/docs/iidm/importer/post-processor/GroovyScriptPostProcessor.md +++ b/docs/iidm/importer/post-processor/GroovyScriptPostProcessor.md @@ -3,7 +3,7 @@ title: GroovyScriptPostProcessor layout: default --- -The `com.powsybl.iidm.import_.GroovyScriptPostProcessor` class is an implementation of the `com.powsybl.iidm.import_.ImportPostProcessor` +The `com.powsybl.iidm.converter.GroovyScriptPostProcessor` class is an implementation of the `com.powsybl.iidm.converter.ImportPostProcessor` interface that runs a Groovy script after a IIDM network is loaded. The groovy script has access to two variables: @@ -49,7 +49,7 @@ To use the Groovy post processor, add the following dependencies to the `pom.xml ```xml com.powsybl - powsybl-iidm-converter-api + powsybl-iidm-api ${powsybl.version} ``` \ No newline at end of file diff --git a/docs/iidm/importer/post-processor/JavaScriptPostProcessor.md b/docs/iidm/importer/post-processor/JavaScriptPostProcessor.md index e1614933..68eb7290 100644 --- a/docs/iidm/importer/post-processor/JavaScriptPostProcessor.md +++ b/docs/iidm/importer/post-processor/JavaScriptPostProcessor.md @@ -3,7 +3,7 @@ title: JavaScriptPostProcessor layout: default --- -The `com.powsybl.iidm.import_.JavaScriptPostProcessor` class is an implementation of the `com.powsybl.iidm.import_.ImportPostProcessor` +The `com.powsybl.iidm.converter.JavaScriptPostProcessor` class is an implementation of the `com.powsybl.iidm.converter.ImportPostProcessor` interface that runs a JS script after a IIDM network is loaded. The JS script has access to two variables: @@ -50,7 +50,7 @@ To use the Groovy post processor, add the following dependencies to the `pom.xml ```xml com.powsybl - powsybl-iidm-converter-api + powsybl-iidm-api ${powsybl.version} ``` diff --git a/docs/iidm/importer/post-processor/LoadFlowResultsCompletionPostProcessor.md b/docs/iidm/importer/post-processor/LoadFlowResultsCompletionPostProcessor.md index d19731ad..373b9c63 100644 --- a/docs/iidm/importer/post-processor/LoadFlowResultsCompletionPostProcessor.md +++ b/docs/iidm/importer/post-processor/LoadFlowResultsCompletionPostProcessor.md @@ -3,7 +3,7 @@ title: LoadFlowResultsCompletionPostProcessor layout: default --- -The `com.powsybl.loadflow.LoadFlowResultsCompletionPostProcessor` class is an implementation of the `com.powsybl.iidm.import_.ImportPostProcessor` +The `com.powsybl.loadflow.LoadFlowResultsCompletionPostProcessor` class is an implementation of the `com.powsybl.iidm.converter.ImportPostProcessor` interface that aims at completing the loadflow results of a network, computing and assigning, if not already set, the flows at the end of branches. diff --git a/docs/iidm/importer/ucte.md b/docs/iidm/importer/ucte.md index 1fab013f..9dbc9c12 100644 --- a/docs/iidm/importer/ucte.md +++ b/docs/iidm/importer/ucte.md @@ -46,7 +46,7 @@ To support UCTE-DEF files, add the following dependencies to the `pom.xml` file: com.powsybl - powsybl-ucte-network + powsybl-ucte-api ${powsybl.version} ``` diff --git a/docs/tools/convert-network.md b/docs/tools/convert-network.md index 41838e95..b3eb5a39 100644 --- a/docs/tools/convert-network.md +++ b/docs/tools/convert-network.md @@ -88,7 +88,7 @@ To use the `convert-network` command, add the following dependencies to the `pom ```xml com.powsybl - powsybl-iidm-converter-api + powsybl-iidm-api ${powsybl.version} ``` diff --git a/docs/tutorials/iidm/exporter.md b/docs/tutorials/iidm/exporter.md index f7800a05..23b9440a 100644 --- a/docs/tutorials/iidm/exporter.md +++ b/docs/tutorials/iidm/exporter.md @@ -15,7 +15,7 @@ In order to do so, you will need to: In order to implement a new `Exporter`, add the following dependencies - `auto-service (com.google.auto.service)`: Configuration/metadata generator for `ServiceLoader`-style providers -- `powsybl-iidm-converter-api`: IIDM network import/export API +- `powsybl-iidm-api`: IIDM network API in your `pom.xml` file: @@ -28,7 +28,7 @@ in your `pom.xml` file: com.powsybl - powsybl-iidm-converter-api + powsybl-iidm-api ${powsybl.core.version} @@ -41,7 +41,7 @@ implementation. Here is an empty class template of an `Exporter` implementation: ```java import com.powsybl.commons.datasource.DataSource; -import com.powsybl.iidm.export.Exporter; +import com.powsybl.iidm.converter.Exporter; import com.powsybl.iidm.network.Network; import java.util.Properties; diff --git a/docs/tutorials/iidm/importer.md b/docs/tutorials/iidm/importer.md index aff4e939..bb70227b 100644 --- a/docs/tutorials/iidm/importer.md +++ b/docs/tutorials/iidm/importer.md @@ -15,7 +15,7 @@ In order to do so, you will need to: In order to implement a new `Importer`, add the following dependencies in your `pom.xml` file: - `auto-service (com.google.auto.service)`: Configuration/metadata generator for `ServiceLoader`-style providers -- `powsybl-iidm-converter-api`: IIDM network import/export API +- `powsybl-iidm-api`: IIDM network API ```xml @@ -26,7 +26,7 @@ In order to implement a new `Importer`, add the following dependencies in your ` com.powsybl - powsybl-iidm-converter-api + powsybl-iidm-api ${powsybl.core.version} @@ -40,7 +40,7 @@ implementation. Here is an empty class template of an `Importer` implementation: ```java import com.powsybl.commons.datasource.DataSource; import com.powsybl.commons.datasource.ReadOnlyDataSource; -import com.powsybl.iidm.import_.Importer; +import com.powsybl.iidm.converter.Importer; import com.powsybl.iidm.network.Network; import com.powsybl.iidm.parameters.Parameter; diff --git a/docs/tutorials/itools/extend-itools.md b/docs/tutorials/itools/extend-itools.md index c5009f6d..38eccef1 100644 --- a/docs/tutorials/itools/extend-itools.md +++ b/docs/tutorials/itools/extend-itools.md @@ -44,12 +44,12 @@ dependencies to implement a new `iTools` command are the following: In your project you also need to add the other dependencies required by your command business logic implementation, e.g. to implement the `iTools` command displaying the number of lines of a network, you would have to add the following -dependency to get the IIDM converter API, needed to import IIDM networks: +dependency to get the IIDM API, needed to import IIDM networks: ```xml com.powsybl - powsybl-iidm-converter-api + powsybl-iidm-api ${powsybl.version} ```