diff --git a/backup/EmptyContingencyListProvider.md b/backup/EmptyContingencyListProvider.md deleted file mode 100644 index 50b5f1ff..00000000 --- a/backup/EmptyContingencyListProvider.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: EmptyContingencyListProvider -layout: default ---- - -The `com.powsybl.contingency.EmptyContingencyListProvider` is a special implementation of the -[ContingenciesProvider](index.md#ContingenciesProvider) interface that provided an empty list of contingencies. This -implementation should be use to check violations on a N-state. - -# Configuration - -To use the `EmptyContingencyListProvider`, configure the `ContingenciesProviderFactory` property of the -[componentDefaultConfig](../pages/documentation/user/configuration/componentDefaultConfig.md) module. - -## YAML -```yaml -componentDefaultConfig: - ContingenciesProviderFactory: com.powsybl.contingency.EmptyContingencyListProviderFactory -``` - -## XML -```xml - - com.powsybl.action.dsl.GroovyDslContingenciesProviderFactory - -``` diff --git a/backup/configuration/itools.md b/backup/configuration/itools.md deleted file mode 100644 index 0bf1f06e..00000000 --- a/backup/configuration/itools.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: itools.conf -layout: default ---- - -The `POWSYBL_HOME/etc/itools.conf` file is a [properties](https://en.wikipedia.org/wiki/.properties) file that contains -system properties to configure the framework. It is generated by the [itools-packager](../installation/itools-packager.md) -maven plugin. - -# Properties - -## java_xmx -The `java_xmx` property is an optional property that defines the amount of the Java Heap memory. The default value is 8 Gb. - -## powsybl_config_dirs -The `itools_config_dir` property is an optional property that defines the configuration folders. The default -value is `$HOME/.itools`. The folders are separated by a colon. - -## powsybl_config_name -The `powsybl_config_name` property is an optional property that defines the basename of the configuration file. The default -value is `config`. - -At startup, Powsybl looks in the configuration directories defined in the `powsybl_config_dirs` for a YAML configuration -file first, for a XML configuration file then and finally for properties files. - -All the configuration files are stacked to allow a user to partially or totally overload the system configuration of a -module. - -# Deprecated properties - -## itools_cache_dir -The `itools_cache_dir` property is deprecated since V2.2.0. The `itools_cache_dir` property was an optional property that -defined the path to the cache folder used by modules that required cache functionalities. The default value was -`$HOME/.cache/itools`. - -## itools_config_dir -The `itools_config_dir` property is deprecated since V2.2.0. Use the `powsybl_config_dirs` property instead. - -## itools_config_name -The `itools_config_name` property is deprecated since V2.2.0. Use the `powsybl_config_name` property instead. - -## mpi_hosts -The `mpi_hosts` property is deprecated since V3.0.0. This parameter is configured in [itools-mpi.conf](../itools-mpi.md). - -## mpi_tasks -The `mpi_tasks` property is deprecated since V3.0.0. This parameter is configured in [itools-mpi.conf](../itools-mpi.md). - -# Example -```properties -# Configuration's directories -powsybl_config_dirs=$HOME/powsybl/etc:$HOME/.itools - -# Configuration's file basename -powsybl_config_name=config - -# Java maximum heap memory -java_xmx=8G -``` diff --git a/backup/configuration/parameters/DynamicSimulationParameters.md b/backup/configuration/parameters/DynamicSimulationParameters.md deleted file mode 100644 index e4146e98..00000000 --- a/backup/configuration/parameters/DynamicSimulationParameters.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: DynamicSimulationParameters -layout: default ---- - -The `com.powsybl.dynamicsimulation.DynamicSimulationParameters` class provides the generic parameters for all `com.powsybl.dynamicsimulation.DynamicSimulation` -implementations. Specific parameters should be provided as an extension of the `DynamicSimulationParameters` class. - -# Properties - -## startTime -The `startTime` property is an optional property that defines the instant of time at which the dynamic simulation begins, in -seconds. - -## stopTime -The `stopTime` property is an optional property that defined the instant of time at which the dynamic simulation ends, in -seconds. - -# Configuration -The default values of all the optional properties are read from the [dynamic-simulation-default-parameter](../../../pages/documentation/user/configuration/dynamic-simulation-default-parameters.md) -module, defined in the configuration file. - -## Examples -```json -{ - "version": "1.0" - "startTime": 0 - "stopTime": 3600 - "extensions": { - ... - } -} - -``` diff --git a/backup/configuration/parameters/DynawoSimulationParameters.md b/backup/configuration/parameters/DynawoSimulationParameters.md deleted file mode 100644 index 113f3238..00000000 --- a/backup/configuration/parameters/DynawoSimulationParameters.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: DynawoSimulationParameters -layout: default ---- - -The `com.powsybl.dynawo.simulator.DynawoSimulationParameters` class provides the specific parameters of a dynamic simulation run with Dynawo. - -# Properties - -## parametersFile -The `parametersFile` property is a required property that defines the path of the main parameters file. - -## network.parametersFile -The `network.parametersFile` property is a required property that defines the path of the network parameters file - -## network.parametersId -The `network.parametersId` property is an optional property that defines the set of network parameters. The default value for this property is `NETWORK`. - -## solver.type -The `solver.type` property is an optional property that defines the solver used in the simulation. The default value for this property is `SIM`. The available `com.powsybl.dynawo.simulator.DynawoSimulationParameters.SolverType` -values are: -- SIM: the simplified solver (fixed time step solver) -- IDA: the IDA solver (variable time step solver) - -## solver.parametersFile -The `solver.parametersFile` property is a required property that defines the path of the solver parameters file - -## solver.parametersId -The `solver.parametersId` property is an optional property that defines the set of solver parameters. The default value for this property is `SIM`. - -# Configuration -The default values of all the optional properties are read from the [dynawo-default-parameter](../../../pages/documentation/user/configuration/dynawo-default-parameters.md) -module, defined in the configuration file. diff --git a/backup/configuration/parameters/SecurityAnalysisParameters.md b/backup/configuration/parameters/SecurityAnalysisParameters.md deleted file mode 100644 index 04019712..00000000 --- a/backup/configuration/parameters/SecurityAnalysisParameters.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: SecurityAnalysisParameters -layout: default ---- - -The `com.powsybl.security.SecurityAnalysisParameters` class provides the generic parameters for all `com.powsybl.security.SecurityAnalysis` -implementations. Specific parameters should be provided as an extension of the `SecurityAnalysisParameters` class. - -# Properties - -## load-flow-parameters -The `load-flow-parameters` property is an optional property that defines the [LoadFlowParameters](LoadFlowParameters.md) -to use. If this property is not set, the default values of all the optional properties are read from -the [load-flow-default-parameters](../../../pages/documentation/user/configuration/load-flow-default-parameters.md) module, defined in the -configuration file. - -# Examples -```json -{ - "version" : "1.0", - "load-flow-parameters" : { - "voltageInitMode" : "PREVIOUS_VALUES", - "transformerVoltageControlOn" : true, - "phaseShifterRegulationOn" : false, - "noGeneratorReactiveLimits" : true, - "specificCompatibility" : false, - "extensions" : { - ... - }, - }, - "extensions" : { - ... - } -} -``` - -Note that there are two `extensions` field. The first one contains the extensions of the `LoadFlowParameters` whereas the -the second one contains the extensions of the `SecurityAnalysisParameters`. diff --git a/backup/configuration/providers/index.md b/backup/configuration/providers/index.md deleted file mode 100644 index 1124c4e8..00000000 --- a/backup/configuration/providers/index.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Configuration Providers -layout: default ---- - -Configuration can typically come from different sources. For exemple, command line or desktop apps usually store the configuration in files in the user home directory; server deployments might use a central configuration database; or during testing, the configuration might be hardcoded in the test. - -To implement this behavior, Powsybl defines a Configuration Provider interface: `com.powsybl.commons.config.PlatformConfigProvider`. You can use the implementations shipped with Powsybl or implement your own. - -Note: The `iTools` and `GSE` distributions automatically use the `ClassicPlatformConfigProvider` so you don't have to think about it when using these programs. But if you are a developper using Powsybl as a plain java library, you must choose a configuration provider. To choose a configuration provider, ensure that it is the only implementation of PlatformConfigProvider available to Java's ServiceLoader. Otherwise, you will get one the following exceptions: -``` -com.powsybl.commons.PowsyblException: Platform configuration provider not found - at com.powsybl.commons.config.PlatformConfig.defaultConfig (PlatformConfig.java:70) - [...] -``` -or -``` -com.powsybl.commons.PowsyblException: Multiple platform configuration providers found - at com.powsybl.commons.config.PlatformConfig.defaultConfig (PlatformConfig.java:74) - [...] -``` - - - -## List of Configuration Providers - -### Classic Config -The ClassicPlatformConfigProvider is described in [Modules configuration](../modules/). It is the historical and main way to configure Powsybl. Add the following dependency in the pom.xml of your project to use it: -```xml - - com.powsybl - powsybl-config-classic - ${powsybl.version} - -``` - -### Test Config -The TestPlatformConfigProvider reads all the config from the classpath, making the test indepedant from the user's filesystem. This is done to have reproducible tests. Add the following dependency in the pom.xml of your project to use it: -```xml - - com.powsybl - powsybl-config-test - ${powsybl.version} - -``` -The files must be present in the classpath in the folder "com/powsybl/config/test/" and must also be listed manually (this is a limitation due to how resource loading from the classpath works) in the file "com/powsybl/config/test/filelist.txt". For example, to specify a config.yml used by maven for tests, put the files in -``` -src/test/resources/com/powsybl/config/test/filelist.txt -src/test/resources/com/powsybl/config/test/config.yml -``` -Put the following content in filelist.txt: -``` -config.yml -``` diff --git a/backup/installation/itools-packager.md b/backup/installation/itools-packager.md deleted file mode 100644 index c832cacf..00000000 --- a/backup/installation/itools-packager.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: itools-packager -layout: default ---- - -The `itools-packager` Maven plugin provides a way to assemble distribution bundles based on [iTools](../tools/index.md). - -The layout of such distribution is the following: -``` - -├── bin -│   ├── itools -│   ├── itools.bat -│   └── powsyblsh -├── etc -│   ├── itools.conf -│   └── logback-itools.xml -├── lib -└── share - └── java - ├── -``` - -# Goals overview -The `itools-packager` only has one goal. -- The `package-zip` goal creates a zip package based on `iTools` - -# Configuration - -## Properties - -### archiveName -The `archiveName` property defines the basename of the archive. If this property is not set, `itools-packager` uses the -packageName. - -### packageName -The `packageName` property defines the name of the root folder of the distribution. If this property is not set, -`itools-packager` uses the finalName of the maven project. - -### configName -The `configName` property defines the the basename of the configuration file. The default value is `config` - -### javaXmx -The `javaXmx` property defines the amout of the Java Heap memory. The default value is 8 Gb. This property is used to -initialize the `java_xmx` property of the `itools.conf` file. - -### copyToBin -The `copyToBin` property defines the list of files to copy in the `bin` directory of the distribution. - -### copyToLib -The `copyToLib` property defines the list of files to copy in the `etc` directory of the distribution. - -### copyToEtc -The `copyToEtc` property defines the list of files to copy in the `etc` directory of the distribution. - -## Example -```xml - - - - com.powsybl - powsybl-itools-packager-maven-plugin - ${powsybl.core.version} - - - package - - package-zip - - - - - powsybl - powsybl-V${project.version} - 512M - - - - -``` - -# Usage -The `itools-packager` plugin copies all the maven dependencies to the `share/java` folder of the distribution. To enable -a feature, add a runtime dependency to the `pom.xml` file. Refer to the [iTools](../tools/index.md) documentation to -learn more about existing `iTools` commands. - -The `itools-packager` demo gives the minimal configuration of an `iTools` based distribution. -```shell -$> git clone https://github.com/powsybl/powsybl-tutorials.git -$> cd powsybl-tutorials/itools-packager -$> mvn package -$> cd target/powsybl/bin -$> ./itools --help -usage: itools [OPTIONS] COMMAND [ARGS] - -Available options are: - --config-name Override configuration file name - -Available commands are: - -``` diff --git a/backup/itools-mpi.md b/backup/itools-mpi.md deleted file mode 100644 index e2e278ab..00000000 --- a/backup/itools-mpi.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: itools-mpi.conf -layout: default ---- - -The `POWSYBL_HOME/etc/itools-mpi.conf` file is a [properties](https://en.wikipedia.org/wiki/.properties) file that contains -system properties to configure MPI tasks. This configuration file is read by the `itools-mpi` script, that runs computations -on a MPI cluster. - -# Properties - -## mpi_hosts -The `mpi_hosts` property is a required property to run parallel command with MPI that defines the list of hosts of the MPI -cluster. The hosts are separated by a comma. - -## mpi_tasks -The `mpi_tasks` property is a required property to run parallel command wih MPI that defines the maximum number of parallel -tasks. - -# Example -```properties -# MPI maximum parallel tasks count -mpi_tasks=2 - -# MPI comma sperated hosts list -mpi_hosts=localhost -``` diff --git a/backup/plugins-info.md b/backup/plugins-info.md deleted file mode 100644 index 8aa5c766..00000000 --- a/backup/plugins-info.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: plugins-info -layout: default -todo: - - add links to the different kind of plugins - - update the list of available plugins ---- - -The `plugins-info` command prints for each kind of plugin, the currently available implementations Ids. The available -kind of plugins are: -- [exporter](../iidm/exporter/index.md) -- [import-post-processor](../iidm/importer/post-processor/index.md) -- [importer](../iidm/importer/index.md) -- [loadflow-validation computation](../loadflow/validation.md) - -# Usage -```shell -$> itools plugins-info -Plugins: -+---------------------------------+-----------------------------------------------------+ -| Plugin type name | Available plugin IDs | -+---------------------------------+-----------------------------------------------------+ -| exporter | AMPL, XIIDM | -| import-post-processor | groovyScript, javaScript, loadflowResultsCompletion | -| importer | CGMES, UCTE, XIIDM | -| loadflow-validation computation | loadflow, loadflowResultsCompletion | -+---------------------------------+-----------------------------------------------------+ -``` - -# Maven configuration -To use the `plugins-info` command, add the following dependencies to the `pom.xml` file: -```xml - - com.powsybl - powsybl-tools - ${powsybl.version} - -``` diff --git a/backup/run-impact-analysis.md b/backup/run-impact-analysis.md deleted file mode 100644 index a6717823..00000000 --- a/backup/run-impact-analysis.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: run-impact-analysis -layout: default -todo: - - add link to IPST implementation (pclf / https://github.com/itesla/ipst/tree/master/pclfsim-integration) ---- - -The `run-impact-analysis` command is used to run dynamic simulations on one or several networks, for all the configured -contingencies and re-calculate all the predefined security-indexes. - -# Usage -```shell -$> itools run-impact-analysis --help -usage: itools [OPTIONS] run-impact-analysis --case-file [--contingencies - ] [--help] [-I ] [--import-parameters - ] [--output-csv-file ] - - -Available options are: - --config-name Override configuration file name - -Available arguments are: - --case-file the case path - --contingencies contingencies to test separated by , - (all the db in not set) - --help display the help and quit --I use value for given - importer parameter - --import-parameters the importer configuation - file - --output-csv-file output CSV file path (pretty print - on standard output if not specified) -``` - -## Required parameters - -### case-file -Use the `--case-file` to specify the path of the case file. - -## Optional parameters - -### contingencies -Use the `--contingencies` parameter to filter the list of contingencies to simulate. If this parameter is not set, all -the contingencies provided by the `com.powsybl.contingency.ContingencyProvider` are simulated. - -### import-parameters -Use the `--import-parameters` parameter to specify the path of the configuration file of the importer. It is possible to -overload one or many parameters using the `-I property=value` parameter. The properties depend on the input format. -Refer to the documentation page of each [importer](../iidm/importer/index.md) to know their specific configuration. - -### output-csv-file -Use the `--output-csv-file` parameter to export the output to the specified CSV file. If this parameter is not set, the -outputs are printed to the console. - -# Configuration -To run an impact analysis, one has to choose the implementation of the `com.powsybl.contingency.ContingenciesProviderFactory` -to use, by setting the `ContingenciesProviderFactory` property to the [componentDefaultConfig](../pages/documentation/user/configuration/componentDefaultConfig.md) -module. To learn more about contingencies or available `ContingenciesProvider` read this [documentation](../contingencies/index.md) page. - -Read the [simulation-parameters](../pages/documentation/user/configuration/simulation-parameters.md) documentation to learn how to -configure the impact analysis parameters. - -# Maven configuration -To use `run-impact-analysis` command, add the following dependencies to the `pom.xml` file: -```xml - - com.powsybl - powsybl-simulation-api - ${powsybl.version} - -``` diff --git a/backup/schema-iidm.png b/backup/schema-iidm.png deleted file mode 100644 index 40eb1d6f..00000000 Binary files a/backup/schema-iidm.png and /dev/null differ diff --git a/backup/to_sort/configuration.md b/backup/to_sort/configuration.md deleted file mode 100644 index 1b08076a..00000000 --- a/backup/to_sort/configuration.md +++ /dev/null @@ -1,49 +0,0 @@ -# Configuration providers - -Configuration can typically come from different sources. For example, command line or desktop apps usually store the configuration in files in the user home directory; server deployments might use a central configuration database; or during testing, the configuration might be hardcoded in the test. - -To implement this behavior, PowSyBl defines a Configuration Provider interface: `com.powsybl.commons.config.PlatformConfigProvider`. You can use the implementations shipped with PowSyBl or implement your own. - -Note: The `iTools` distribution automatically uses the `ClassicPlatformConfigProvider` so you don't have to think about it when using it. But if you are a developper using PowSyBl as a plain java library, you must choose a configuration provider. To choose a configuration provider, ensure that it is the only implementation of PlatformConfigProvider available to Java's ServiceLoader. Otherwise, you will get one the following exceptions: -``` -com.powsybl.commons.PowSyBlException: Platform configuration provider not found - at com.powsybl.commons.config.PlatformConfig.defaultConfig (PlatformConfig.java:70) - [...] -``` -or -``` -com.powsybl.commons.PowSyBlException: Multiple platform configuration providers found - at com.powsybl.commons.config.PlatformConfig.defaultConfig (PlatformConfig.java:74) - [...] -``` - -## List of Configuration Providers - -### Classic Config -The ClassicPlatformConfigProvider is described in [Modules configuration](../modules/). It is the historical and main way to configure PowSyBl. Add the following dependency in the pom.xml of your project to use it: -```xml - - com.powsybl - powsybl-config-classic - ${powsybl.version} - -``` - -### Test Config -The TestPlatformConfigProvider reads all the config from the classpath, making the test indepedant from the user's filesystem. This is done to have reproducible tests. Add the following dependency in the pom.xml of your project to use it: -```xml - - com.powsybl - powsybl-config-test - ${powsybl.version} - -``` -The files must be present in the classpath in the folder "com/powsybl/config/test/" and must also be listed manually (this is a limitation due to how resource loading from the classpath works) in the file "com/powsybl/config/test/filelist.txt". For example, to specify a config.yml used by maven for tests, put the files in -``` -src/test/resources/com/powsybl/config/test/filelist.txt -src/test/resources/com/powsybl/config/test/config.yml -``` -Put the following content in filelist.txt: -``` -config.yml -``` diff --git a/backup/tutorials/iidm/exporter.md b/backup/tutorials/iidm/exporter.md deleted file mode 100644 index 3b615ca9..00000000 --- a/backup/tutorials/iidm/exporter.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -title: How to write an IIDM exporter -layout: default ---- - -From Powsybl's [Exporter](../../iidm/exporter/index.md) interface, it is possible to add a new data serialization format -for a [IIDM](../../iidm/model/index.md) network. - -In order to do so, you will need to: -- Write an implementation of the `Exporter` interface and assign it a unique ID format -- Declare the new class as a service implementation with the `@AutoService` annotation -- Build your jar - -# Configuring your module - -In order to implement a new `Exporter`, 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 - -```xml - - - com.google.auto.service - auto-service - 1.0-rc2 - - - com.powsybl - powsybl-iidm-converter-api - ${powsybl.core.version} - - -``` - -# Implementation - -As said above, you will need to write your own implementation of the `Exporter` interface and declare it as a service -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.network.Network; - -import java.util.Properties; - -@AutoService(Exporter.class) -public class MyExporter implements Exporter { - - /** - * @return the unique ID for the given format - */ - @Override - public String getFormat() { - return null; - } - - /** - * @return information about the exporter - */ - @Override - public String getComment() { - return null; - } - - /** - * @param network the IIDM network to export - * @param parameters properties specific to this exporter - * @param dataSource access to outputStream - */ - @Override - public void export(Network network, Properties parameters, DataSource dataSource) { - // business logic to export a model to a given format - } - -} -``` - -# Deployment - -## Generating jar - -Once your implementation is ready, run the following command to create your project jar: -``` -$ cd -$ mvn clean package -``` - -The jar file will be generated in `/target`. - -## Adding the format in iTools - -[iTools](../../tools/index.md) allows the user to convert a network from one format to another via the -[convert-network](../../tools/convert-network.md) command line. - -You can add your custom export format to the available output formats of the command by copying the generated jar in -your powsybl distribution: -``` -$> cp target/my-exporter.jar /share/java -``` - -# Examples - -The code of a simple CSV Exporter is available in [powsybl-tutorials](https://github.com/powsybl/powsybl-tutorials) as a -complete example of this tutorial. - -To try it, clone the project and deploy as below: -``` -$ git clone https://github.com/powsybl/powsybl-tutorials.git -$ cd powsybl-tutorials/csv-exporter -$ mvn clean package -``` diff --git a/backup/tutorials/iidm/importer.md b/backup/tutorials/iidm/importer.md deleted file mode 100644 index 3ba8fbbc..00000000 --- a/backup/tutorials/iidm/importer.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: How to write an IIDM importer -layout: default ---- - -From Powsybl's [Importer](../../iidm/importer/index.md) interface, it is possible to add a new file format from which -an [IIDM](../../iidm/model/index.md) data model can be loaded. - -In order to do so, you will need to: -- Write an implementation of the `Importer` interface -- Declare the new class as a service implementation with the `@AutoService` annotation -- Build your jar - -# Configuring your module - -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 - -```xml - - - com.google.auto.service - auto-service - 1.0-rc2 - - - com.powsybl - powsybl-iidm-converter-api - ${powsybl.core.version} - - -``` - -# Implementation - -As said above, you will need to write your own implementation of the `Importer` interface and declare it as a service -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.network.Network; -import com.powsybl.iidm.parameters.Parameter; - -import java.util.List; -import java.util.Properties; - -@AutoService(Importer.class) -public class MyImporter implements Importer { - - /** - * Get a unique identifier of the format. - * - * @return the unique ID for the given format - */ - @Override - public String getFormat() { - return null; - } - - /** - * This override is optional. By default, it returns Collections.emptyList() - * - * @return description of import parameters - */ - @Override - public List getParameters() { - return Collections.emptyList(); - } - - /** - * Get some information about this importer. - * - * @return information about the importer - */ - @Override - public String getComment() { - return null; - } - - /** - * Check if the data source is importable - * - * @param dataSource the data source - * @return true if the data source is importable, false otherwise - */ - @Override - public boolean exists(ReadOnlyDataSource dataSource) { - return false; - } - - /** - * Create a model. - * - * @param dataSource data source - * @param parameters some properties to configure the import - * @return the model - */ - @Override - public Network importData(ReadOnlyDataSource dataSource, Properties parameters) { - // business logic to import a network from a data source in a given format - return null; - } - - /** - * Copy data from one data source to another. - * - * @param fromDataSource from data source - * @param toDataSource destination data source - */ - @Override - public void copy(ReadOnlyDataSource fromDataSource, DataSource toDataSource) { - // business logic to copy a network from a data source to another file in a given format - } -} -``` - -# Deployment - -## Generating jar - -Once your implementation is ready, run the following command to create your project jar: -``` -$ cd -$ mvn clean package -``` - -The jar file will be generated in `/target`. - -## Adding the format in iTools - -[iTools](../../tools/index.md) allows the user to convert a network from one format to another via the -[convert-network](../../tools/convert-network.md) command line. - -You can add your custom import format, allowing files in this format to be converted using the command, by copying the -generated jar in your powsybl distribution: -``` -$> cp target/my-exporter.jar /share/java -``` - -# Examples - -The code of a simple CSV Importer is available in [powsybl-tutorials](https://github.com/powsybl/powsybl-tutorials) as a -complete example of this tutorial. - -To try it, clone the project and deploy as below: -``` -$ git clone https://github.com/powsybl/powsybl-tutorials.git -$ cd powsybl-tutorials/csv-importer -$ mvn clean package -``` diff --git a/backup/tutorials/index.md b/backup/tutorials/index.md deleted file mode 100644 index 2102b61a..00000000 --- a/backup/tutorials/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Advanced tutorials -layout: default ---- - -## Deployment - -- [How to use PowSyBl as a custom desktop application](powsybl-javafx-packager.md) -- [How to use PowsyBl as a command line](../todo.md) - -## Using PowSyBl APIs - -- [How to use AFS](afs/afs.md) - -## Extending PowSyBl APIs - -- [How to extend AFS](../todo.md) -- [How to write an IIDM exporter](iidm/exporter.md) -- [How to write an IIDM importer](iidm/importer.md) -- [How to extend iTools](itools/extend-itools.md) diff --git a/backup/tutorials/itools/extend-itools.md b/backup/tutorials/itools/extend-itools.md deleted file mode 100644 index aeb60513..00000000 --- a/backup/tutorials/itools/extend-itools.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -title: How to extend iTools -layout: default ---- - -The `iTools` script is designed to be easily extended with new commands that would be added to the set of -available commands, providing users with new command line functionalities. Read this documentation [page](../../tools/index.md) -to learn more... - -In order to create a new `iTools` command: -1. Create a new maven project and add all the required dependencies. -2. Implement the `com.powsybl.tools.Tool` interface. -3. Compile your project and add the jar to your powsybl installation. - -In the following sections we will see how, following these steps, you can implement a new `iTools` command to display -how many lines there are in a network. - -The complete example described in this tutorial is available on GitHub: -```shell -$> git clone https://github.com/powsybl/powsybl-tutorials.git -$> cd powsybl-tutorials/count-network-lines -$> mvn package -``` - -# Maven dependencies - -After creating a new Maven project, you need to add the necessary dependencies to your `pom.xml` file. The required -dependencies to implement a new `iTools` command are the following: -- Google Auto Service to declare your new tool as a plugin -- The Powsybl tools module which contains the base interfaces for all `iTools` commands - -```xml - - com.google.auto.service - auto-service - 1.0-rc2 - - - com.powsybl - powsybl-tools - ${powsybl.version} - -``` - -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: - -```xml - - com.powsybl - powsybl-iidm-converter-api - ${powsybl.version} - -``` - -# Implement the Tool interface - -To create a new `iTools` command, you need to implement the `com.powsybl.tools.Tool` interface. Following is a sample -class, where you will put the code to display the number of lines of an IIDM network. - -```java -import com.google.auto.service.AutoService; - -import org.apache.commons.cli.CommandLine; - -import com.powsybl.tools.Command; -import com.powsybl.tools.Tool; -import com.powsybl.tools.ToolRunningContext; - -@AutoService(Tool.class) -public class CountNetworkLinesTool implements Tool { - - @Override - public Command getCommand() { - return null; - } - - @Override - public void run(CommandLine line, ToolRunningContext context) { - } -} -``` - -You have to declare the class as a service implementation, using the `@Autoservice` annotation. This will allow you to -have the new command automatically added to the list of available `iTools` commands, and to be able to run it (see last -section). - -The methods of the `Tool` interface to override in your class are: -- the `getCommand` method, that returns the declaration of your command -- the `run` method, in charge of running your command - -## Implementing the `getCommand` method -The `getCommand` method returns an instance of the `com.powsybl.tools.Command` interface. This interface declares your -command, defining its name, its description and a theme. The theme is used to group the commands by category. Please read -this documentation [page](../../tools/index.md#available-commands) to discover the existing -themes. In our tutorial, we chose to create a new theme, called `Network`. - -```java - private static final String CASE_FILE = "case-file"; - - @Override - public Command getCommand() { - return new Command() { - - @Override - public String getName() { - return "count-network-lines"; - } - - @Override - public String getTheme() { - return "Network"; - } - - @Override - public String getDescription() { - return "Count network lines"; - } - - @Override - public Options getOptions() { - Options options = new Options(); - options.addOption(Option.builder().longOpt(CASE_FILE) - .desc("the case path") - .hasArg() - .argName("FILE") - .required() - .build()); - return options; - } - - @Override - public String getUsageFooter() { - return null; - } - }; - } -``` - -The `Command` class also defines your command options (input parameters), if they are required or optional and if they -need an argument or not. The only option defined in our sample class, `case-file`, allows the user to specify the network -file to analyze. This option is required and has an argument named `FILE` to get the input case file: -```java - options.addOption(Option.builder().longOpt(CASE_FILE) - .desc("the case path") - .hasArg() - .argName("FILE") - .required() - .build()); - -``` -Read the [commons-cli](https://www.javadoc.io/doc/commons-cli/commons-cli/) documentation page -to learn more. - -## Implementing the `run` method -The `run` method is in charge of running your command, implementing your business logic. This methods has two parameters: -```java - @Override - public void run(CommandLine line, ToolRunningContext context) { - - } -``` - -The `line` parameter gives you access to the input options provided by the user through the command line. In our example, -we use it to read the path to the input network file. - -The `context` parameter provides you with some context objects, such as an `OutputStream` object allowing you to print some -information in the console, a `ComputationManager` object sometimes required to run computations or a `FileSystem` -object for accessing the local file system (see [ToolRunningContext](https://www.javadoc.io/doc/powsybl-core/powsybl-core/) -for more information). - -In our tutorial, we load the input case file to get an IIDM network instance and assert that the network was loaded -successfully: -```java - Path caseFile = context.getFileSystem().getPath(line.getOptionValue(CASE_FILE)); - context.getOutputStream().println("Loading network '" + caseFile + "'"); - Network network = Importers.loadNetwork(caseFile, context.getShortTimeExecutionComputationManager(), ImportConfig.load(), null); - if (network == null) { - throw new PowsyblException("Case '" + caseFile + "' not found"); - } -``` - -Then we get the number of lines in this network and print a message in the console: -```java - int lineCount = network.getLineCount(); - context.getOutputStream().println("Network contains '" + lineCount + "' lines"); -``` - -# Update your installation with the new command - -Run the following command to build your project jar: -```bash -$> mvn package -``` - -The generated jar will be located under the target folder of your project. Copy the generated jar to the `share/java` -folder of your Powsybl distribution (you might need to copy in this directory other dependencies jars, specific to your -new command). - -Then run `iTools` to check if your command is available: -```shell -$> cd /bin -$> ./itools count-network-lines --help -usage: itools [OPTIONS] count-network-lines --case-file [--help] - -Available options are: - --config-name Override configuration file name - -Available arguments are: - --case-file the case path - --help display the help and quit -``` - -You can run the new command, using the following command: -```shell -$> cd /bin -$> ./itools count-network-lines --case-file ~/network.xiidm -Loading network '~/network.xiidm' -Network contains '2' lines -``` diff --git a/backup/user_stories/images/Compute_Optimizer.svg b/backup/user_stories/images/Compute_Optimizer.svg deleted file mode 100644 index 5167f8b6..00000000 --- a/backup/user_stories/images/Compute_Optimizer.svg +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - Optimizer - - - diff --git a/backup/user_stories/images/Compute_SA.svg b/backup/user_stories/images/Compute_SA.svg deleted file mode 100644 index 706b5b22..00000000 --- a/backup/user_stories/images/Compute_SA.svg +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - SA - - - diff --git a/backup/user_stories/images/Compute_Sensitivity.svg b/backup/user_stories/images/Compute_Sensitivity.svg deleted file mode 100644 index 3256deee..00000000 --- a/backup/user_stories/images/Compute_Sensitivity.svg +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - Sensitivity - - - diff --git a/backup/user_stories/images/Export.svg b/backup/user_stories/images/Export.svg deleted file mode 100644 index a9ea3566..00000000 --- a/backup/user_stories/images/Export.svg +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - diff --git a/backup/user_stories/images/Modify_iAL.svg b/backup/user_stories/images/Modify_iAL.svg deleted file mode 100644 index 15324fec..00000000 --- a/backup/user_stories/images/Modify_iAL.svg +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - iAL - - - - diff --git a/backup/user_stories/images/Network.svg b/backup/user_stories/images/Network.svg deleted file mode 100644 index 2d94ee80..00000000 --- a/backup/user_stories/images/Network.svg +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - diff --git a/backup/user_stories/images/Network_extract.svg b/backup/user_stories/images/Network_extract.svg deleted file mode 100644 index 60d0cc85..00000000 --- a/backup/user_stories/images/Network_extract.svg +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - extract - - - diff --git a/backup/user_stories/images/Network_merging.svg b/backup/user_stories/images/Network_merging.svg deleted file mode 100644 index daf6955b..00000000 --- a/backup/user_stories/images/Network_merging.svg +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - merging - - - diff --git a/backup/user_stories/images/Workflow_Capacity_Calculation_RSC.svg b/backup/user_stories/images/Workflow_Capacity_Calculation_RSC.svg deleted file mode 100644 index 68386d4f..00000000 --- a/backup/user_stories/images/Workflow_Capacity_Calculation_RSC.svg +++ /dev/null @@ -1,699 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - CGMESUCTE - - - LF - - - - - - - - - CRAC - - - Sensitivity - - - - - - - - - - - merging - - - - Action - - - - - - - SA - - - Optimizer - Bestremedialactions - - - - - - - - diff --git a/backup/user_stories/images/[Process]N-1Eurostag.svg b/backup/user_stories/images/[Process]N-1Eurostag.svg deleted file mode 100644 index 280fec2c..00000000 --- a/backup/user_stories/images/[Process]N-1Eurostag.svg +++ /dev/null @@ -1,1492 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 606,5 - 302,4 - 302,4 - 300,4 - 300,4 - 600 - - - - - - - - - - - - - - - - - - - - - - - - 611,4 - 610,6 - 601 - 600 - - - - - - - - - - - - - - - - - - - - - - - - - - - merging - - - - - - - - - - - extract - - - - LF - - - - SA - - - - Sensitivity - - - - iAL - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 606,5 - 302,4 - 302,4 - 300,4 - 300,4 - 600 - - - - - - - - - - - - - - - - - - - - - - - - 611,4 - 610,6 - 601 - 600 - - - - - LF - - - - - N-1 - - - - - - LF - - - - - - - - - - - - - - - - Final state - - - - N-1 - - - - - diff --git a/backup/user_stories/images/busBreakerTopology.svg b/backup/user_stories/images/busBreakerTopology.svg deleted file mode 100644 index bcc62705..00000000 --- a/backup/user_stories/images/busBreakerTopology.svg +++ /dev/null @@ -1,395 +0,0 @@ - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/backup/user_stories/images/busTopology.svg b/backup/user_stories/images/busTopology.svg deleted file mode 100644 index 2546923d..00000000 --- a/backup/user_stories/images/busTopology.svg +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/backup/user_stories/images/nodeBreakerTopology.svg b/backup/user_stories/images/nodeBreakerTopology.svg deleted file mode 100644 index c8428ddf..00000000 --- a/backup/user_stories/images/nodeBreakerTopology.svg +++ /dev/null @@ -1,675 +0,0 @@ - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/backup/user_stories/images/nodeBreakerTopologyGraph.svg b/backup/user_stories/images/nodeBreakerTopologyGraph.svg deleted file mode 100644 index 179f034b..00000000 --- a/backup/user_stories/images/nodeBreakerTopologyGraph.svg +++ /dev/null @@ -1,1126 +0,0 @@ - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - BBS2 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/backup/user_stories/topology.md b/backup/user_stories/topology.md deleted file mode 100644 index 624df646..00000000 --- a/backup/user_stories/topology.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: Second basic tutorial - topology management -layout: default ---- - - -This example aims to create a substation with a node/breaker topology model and to visit it through the bus/breaker and the bus views. -In a second time, we create the same substation with a bus/breaker topology model and we visit it through the bus/breaker and the bus views. -The corresponding code is fully available in the [topology](https://github.com/powsybl/powsybl-tutorials) tutorial. - - - -# Building a network in node/breaker topology model - -The substation of this tutorial has two voltage levels VL1 and VL2 described with a node/breaker topology model. -The first voltage level VL1 has 2 busbar sections BBS1 and BBS2, a generator GN, a load LD and a coupler BR3 between busbar sections BBS1 and BBS2. -The second voltage level VL2 has a single busbar section BBS3, a line LN and is connected to voltage level VL1 through transformer TR. -Below is a diagram of the substation: - -![Node breaker topology](images/nodeBreakerTopology.svg){: width="50%" .center-image} - -The node/breaker topology model is stored inside the voltage level as a graph, in which the vertices correspond to connectivity nodes and the edges correspond to [switches](../iidm/model/switch.md) (or internal connections). -The next diagram shows how to map the substation topology to a graph. - -![Node breaker graph](images/nodeBreakerTopologyGraph.svg){: width="50%" .center-image} - -- Each voltage level has its own topology graph. Voltage level VL1 has 8 connectivity nodes. Generator GN is connected to node 1, load LD to node 5, busbar sections BBS1 and BBS2 to node 3 and 4. 2, 6 and 7 are internal connectivity nodes. -- Voltage level VL2 has 3 nodes, line LN is connected to node 1, busbar section BBS3 to node 2. -- Transformer TR is connected to node 8 of voltage level 400 KV and node 3 of voltage level 225 KV. -- Plain edges represent closed switches. -- Dashed edges represent open switches. -- Green edges will disappear during the bus/breaker topology computation whereas pink edges (like 3<->4 in this case) will be retained, whatever their state (see [switches](../iidm/model/switch.md)). - -## Bus/breaker view - -The following diagram shows the computed bus/breaker topology. -Compared to the node/breaker topology, only the equipements (GN, LD, TR, LN) and the switches flagged as retained (BR3) remain in the network description. -The equipments are now connected through buses (B1, B2 and B3). - -![Bus breaker graph](images/busBreakerTopology.svg){: width="50%" .center-image} - -We can switch to a bus/breaker view on the substation voltage level VL1. -VL1 contains 2 buses in the bus/breaker view. -The first bus connects the nodes 1, 2, 3, 5 and 6, and consequently the generator GN and the load LD. -Note that the load LD does not belong to the connected component, because the switch BR2 is open. -The second bus connects nodes 4, 7 and 8. Note that VL1 contains only one switch in the bus/breaker view (BR3). -Here are the corresponding prints in the tutorial: - -```` -Bus: VL1_1 - Generators: GN -Bus: VL1_4 - T2W: TR -Bus: VL1_5 - Loads: LD, connected component: null -Switch: BR3 -Bus: VL2_1 - T2W: TR -```` - -## Bus view - -The following diagram shows the computed bus topology. Compared to bus/breaker topology, there is no switches anymore. Only remains equipements (GN, TR, LN) connected through buses. LD is not connected. - -![Bus graph](images/busTopology.svg){: width="50%" .center-image} - -We can switch to a bus view on substation voltage level VL1. VL1 contains 1 bus in the bus view. This bus connects all the equipements of voltage level VL1. Here are the corresponding prints in the tutorial: - -```` -Bus:VL1_1 - Generators: GN - T2Ws: TR -Bus:VL2_1 - T2Ws: TR -```` - -# Building a network in bus/breaker topology model - -Note that creating a substation with a bus/breaker topology model is easier. -Instead of creating VL1 and VL3 with a node/breaker topology model, we can directly create them in a simpler bus/breaker topology model. -It can be very useful when data source only contains bus/branch data link in UCTE-DEF or in CIM-CGMES format sometimes. -Warning: in that case the node/breaker view status on voltage level VL1 and VL2 is N/A (not available). -Here are the corresponding prints in the tutorial. Note that the load LD is not printed in that case: - -```` -bus/breaker network in bus/breaker view: -Bus: B1 - Generators: GN -Bus: B2 - T2Ws: TR -Switches: BR3 -Bus: B3 - T2Ws: TR -bus/breaker network in bus view: -Bus:VL1_0 - Generators: GN - T2Ws: TR -Bus:VL2_0 - T2Ws: TR -```` diff --git a/pages/documentation/developer/scripting/groovy.md b/pages/documentation/developer/scripting/groovy.md deleted file mode 100644 index 7e04f5dc..00000000 --- a/pages/documentation/developer/scripting/groovy.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default ---- - -# Groovy scripting -[Apache Groovy](https://groovy-lang.org/) is an object-oriented programming language for the Java platform. This language is widely used in PowSyBl to implement domain specific languages such as the [contingency DSL](../../simulation/securityanalysis/contingency-dsl.md), the [action DSL](../../simulation/securityanalysis/action-dsl.md) or the DSLs for time-domain simulations. With Groovy, you have access to all features of the framework without any payload. - -## iTools run-script -The first way to use Groovy scripts is to use the [iTools run-script](https://powsybl.readthedocs.io/projects/powsybl-core/en/latest/user/itools/run-script.html) command. It relies on a complete [iTools distribution](../../user/index.md#installation-from-binaries). To make it easier to write scripts, we provide a small DSL that allow: -- to load and save a case file -- to easily run power flow simulations. - -It's possible to extend this DSL with user-friendly functions by writing [extensions](). - -## Example -This small example shows how to load a case file and run a power simulation in Groovy: -```groovy -import com.powsybl.loadflow.LoadFlow - -// Load a case file -network = loadNetwork("eurostag-tutorial-example1.xml") - -// Run a power flow with OpenLF implementation -result = LoadFlow.find("OpenLoadFlow").run(network) -println "Computation OK? " + result.isOk() -println "Metrics: " + result.getMetrics() - -// Save the network -saveNetwork("XIIDM", network, null, "eurostag-tutorial-example1-after-lf.xml") -``` diff --git a/pages/documentation/developer/scripting/img/groovy-logo.png b/pages/documentation/developer/scripting/img/groovy-logo.png deleted file mode 100644 index 54af4c18..00000000 Binary files a/pages/documentation/developer/scripting/img/groovy-logo.png and /dev/null differ diff --git a/pages/documentation/developer/scripting/img/python-logo.png b/pages/documentation/developer/scripting/img/python-logo.png deleted file mode 100644 index 6b6ea38b..00000000 Binary files a/pages/documentation/developer/scripting/img/python-logo.png and /dev/null differ diff --git a/pages/documentation/developer/scripting/index.md b/pages/documentation/developer/scripting/index.md deleted file mode 100644 index cfb9e987..00000000 --- a/pages/documentation/developer/scripting/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -layout: default ---- - -# Scripting - -PowSyBl offers two different scripts' languages. Depending on your profile, you may be interested in [python scripting](python.md) or [groovy scripting](groovy.md). - -## Python scripting -PyPowSyBl project allow Python developer to call PowSyBl features written in Java within Python scripts. Python and Java are interfaced at the native level in both virtual machines. This shared memory based approach achieves decent computing performance, while providing the access to the entirety of CPython and Java libraries. - -Learn more > - -## Groovy scripting -[Apache Groovy](https://groovy-lang.org/) is an object-oriented programming language for the Java platform. Within groovy scripts, you have access to all features of the framework without any payload. - -Learn more > - - - diff --git a/pages/documentation/user/configuration/computation-local.md b/pages/documentation/user/configuration/computation-local.md deleted file mode 100644 index 4ebde1d8..00000000 --- a/pages/documentation/user/configuration/computation-local.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default ---- - -# computation-local -The `computation-local` module is used by the `com.powsybl.computation.local.LocalComputationManager` to run computations on the local host, if it is configured in the [default-computation-manager](default-computation-manager.md) module. - -## Optional properties - -**available-core** -The `available-core` property is an optional property that defines the maximum number of parallel computations. The default value of this property is `1`. To use all the processors of the system, set this property to `0`. - -**tmp-dir** -The `tmp-dir` property is an optional property that defines a list of paths where the temporary files generated during the computations can be stored. The temporary files will be generated in the first existing path of this list. If none of the paths exists, a `ConfigurationException` is thrown. The default value of this property is initialized with the `java.io.tmpdir` JVM system property. - -## Deprecated properties - -**availableCore** -The `availableCore` property is deprecated since v2.1.0. Use the `available-core` property instead. - -**tmpDir** -The `tmpDir` property is deprecated since v2.1.0. Use the `tmp-dir` property instead. - -## Examples - -**YAML configuration:** -```yaml -computation-local: - available-core: 1 - tmp-dir: - - /home/user/tmp - - /tmp -``` - -**XML configuration:** -```xml - - 1 - /home/user/tmp:/tmp - -``` diff --git a/pages/documentation/user/configuration/default-computation-manager.md b/pages/documentation/user/configuration/default-computation-manager.md deleted file mode 100644 index a6a0bac6..00000000 --- a/pages/documentation/user/configuration/default-computation-manager.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: default ---- - -# default-computation-manager -The `default-computation-manager` module is an optional module loaded when an `iTools` command starts, to determine which `com.powsybl.computation.ComputationManager` implementation should be used for short-time and long-time computations. The choice of using the short-time or the long-time computation manager factory is done by the implementation of each type of computation (e.g. load-flow, security-analysis, etc.). - -If this module is not set, the `com.powsybl.computation.local.LocalComputationManager` implementation is used. Read the [computation-local](computation-local.md) page to learn how to configure the `LocalComputationManager`. - -## Required properties - -**short-time-execution-computation-manager-factory** -The `short-time-execution-computation-manager-factory` property is a required property that defines the name of the `com.powsybl.computation.ComputationManagerFactory` implementation to use for short-time computations. - -## Optional properties - -**long-time-execution-computation-manager-factory** -The `long-time-execution-computation-manager-factory` property is an optional property that defines the name of the `com.powsybl.computation.ComputationManagerFactory` implementation to use for long-time computations. If not defined, this property returns the same value as the `short-time-execution-manager-factory`. - -## Examples - -**YAML configuration:** -```yaml -default-computation-manager: - long-time-execution-computation-manager-factory: com.powsybl.computation.local.LocalComputationManagerFactory - short-time-execution-computation-manager-factory: com.powsybl.computation.local.LocalComputationManagerFactory -``` - -**XML configuration:** -```xml - - com.powsybl.computation.local.LocalComputationManagerFactory - com.powsybl.computation.local.LocalComputationManagerFactory - -``` diff --git a/pages/documentation/user/configuration/network.md b/pages/documentation/user/configuration/network.md deleted file mode 100644 index f2038c9d..00000000 --- a/pages/documentation/user/configuration/network.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: default ---- - -# network -The `network` module is used to configure the network default implementation name. The network implementation is the set of classes implementing all the network elements, such as VoltageLevel or Generator. The implementation named "Default" is the classic PowSyBl in-memory implementation. - -## Required properties - -**default-impl-name** -The `default-impl-name` property is a required property that specifies the name of the default network implementation. - -## Examples - -**YAML configuration:** -```yaml -network: - default-impl-name: Default -``` - -**XML configuration:** -```xml - - Default - -``` diff --git a/pages/documentation/user/configuration/simulation-parameters.md b/pages/documentation/user/configuration/simulation-parameters.md deleted file mode 100644 index 605d73cb..00000000 --- a/pages/documentation/user/configuration/simulation-parameters.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -layout: default ---- - -# simulation-parameters -The `simulation-parameters` module is used by the [run-impact-analysis]() command or when a dynamic simulation is run. Its properties define a simulation scenario. - -## Required properties - -**branchSideOneFaultShortCircuitDuration** -The `branchSideOneFaultShortCircuitDuration` property is a required property that defines the duration of the short -circuit in seconds for the side `ONE` of a branch. - -**branchSideTwoFaultShortCircuitDuration** -The `branchSideTwoFaultShortCircuitDuration` property is a required property that defines the duration of the short -circuit in seconds for the side `TWO` of a branch. - -**faultEventInstant** -The `faultEventInstant` property is a required property that defines the fault instant event in seconds. - -**generatorFaultShortCircuitDuration** -The `generatorFaultShortCircuitDuration` property is a required property that defines the duration of the short circuit in seconds for a generator. - -**preFaultSimulationStopInstant** -The `preFaultSimulationStopInstant` property is a required property that defines the stop instant event for pre fault -simulations in seconds. - -**postFaultSimulationStopInstant** -The `postFaultSimulationStopInstant` property is a required property that defines the stop instant event for post fault simulations in seconds. - -## Optional properties - -**branchFaultReactance** -The `branchFaultReactance` property is an optional property that defines the branch fault reactance. The default -value of this property is `0.01`. - -**branchFaultResistance** -The `branchFaultResistance` property is an optional property that defines the branch fault resistance. The default -value of this property is 0. - -**branchShortCircuitDistance** -The `branchShortCircuitDistance` property is an optional property that defines the location of the short circuit on the branch in %. The -default value of this property is `50`. - -**generatorFaultReactance** -The `generatorFaultReactance` property is an optional property that defines the generator fault reactance. The default -value of this property is `0.00001`. - -**generatorFaultResistance** -The `generatorFaultResistance` property is an optional property that defines the generator fault resistance. The default value of this property is `0.00001`. - -## Examples - -**YAML configuration:** -```yaml -simulation-parameters: - preFaultSimulationStopInstant: 0.1 - faultEventInstant: 0.2 - branchSideOneFaultShortCircuitDuration: 0.35 - branchSideTwoFaultShortCircuitDuration: 0.75 - generatorFaultShortCircuitDuration: 0.3 - postFaultSimulationStopInstant: 0.8 -``` - -**XML configuration:** -```xml - - 0.1 - 0.2 - 0.35 - 0.75 - 0.3 - 0.8 - -``` diff --git a/pages/documentation/user/configuration/table-formatter.md b/pages/documentation/user/configuration/table-formatter.md deleted file mode 100644 index 8eeffdcd..00000000 --- a/pages/documentation/user/configuration/table-formatter.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -layout: default ---- - -# table-formatter -The `table-formatter` module is used to configure the rendering of tables displayed in the console. It is also used to export data in CSV files. - -## Optional properties - -**invalidString** -The `invalidString` property is an optional property that defines the replacement string to display when a value is absent. The default value of this property is `inv`. - -**language** -The `language` property is an optional property that defines the language code of the locale to use. The default value -of this property is the language code (2-characters code) of the system default locale. - -**printHeader** -The `printHeader` property is an optional property that defines whether the headers of the columns are displayed or not. The default value of this property is `true`. - -**printTitle** -The `printTitle` property is an optional property that defines whether the title of the table is displayed or not. The default value of this property is `true`. - -**separator** -The `separator` property is an optional property that defines the column separator used in CSV files. The default value of this property is `;`. - -## Examples - -**YAML configuration:** -```yaml -table-formatter: - invalidString: inv - language: FR - printHeader: true - printTitle: true - separator: ; -``` - -**XML configuration:** -```xml - - inv - FR - true - true - ; - -``` diff --git a/pages/documentation/user/index.md b/pages/documentation/user/index.md deleted file mode 100644 index adeb456d..00000000 --- a/pages/documentation/user/index.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -layout: default ---- - -# Getting started - -* TOC -{:toc} - -## Introduction - -Follow these simple steps to get familiar with the PowSyBl environment. Below are instructions to install a -basic PowSyBl distribution and to start running iTools commands. - -Please note that this PowSyBl distribution is functional on Windows and Linux but -is not supported for MacOS yet. - -## Installation from binaries - -Start by downloading the [latest version of a PowSyBl distribution](../../download/index.html). -Unzip the downloaded package. You can now add `/powsybl-distribution-/bin` to your environment variable `PATH`. - -You can now use iTools commands in your terminal: - -``` -$> itools --help -usage: itools [OPTIONS] COMMAND [ARGS] - -Available options are: - --config-name Override configuration file name - -Available commands are: - -Computation: - compare-security-analysis-results Compare security analysis results - loadflow Run loadflow - loadflow-validation Validate load-flow results of a network - security-analysis Run security analysis - -Data conversion: - convert-network convert a network from one format to another - -Misc: - plugins-info List the available plugins - -Script: - run-script run script (only groovy is supported) - -``` -**Optional**: You can set a default configuration by copying the provided configuration file in the `.itools` repository -in your `HOME` (note that you will need to create this repository if it does not exist): -``` -$ mkdir /.itools -$ cp /resources/config/config.yml /.itools/config.yml -``` -This step is not mandatory **if you already have a custom configuration file and the necessary configuration modules are filled**. -For more information, go to the [documentation page of the configuration](https://powsybl.readthedocs.io/projects/powsybl-core/en/latest/user/configuration/index.html). - -## Installation from sources - -It is also possible to install PowSyBl distribution from sources. - -First download the sources of [`powsybl-distribution` repository](https://github.com/powsybl/powsybl-distribution): -``` -$ git clone https://github.com/powsybl/powsybl-distribution.git -``` -If you want to work on a stable version, go to [the latest release tag](https://github.com/powsybl/powsybl-distribution/releases/latest): -``` -$ git checkout tags/ -b latest-release -``` - -Generate a basic PowSyBl distribution by launching from the root repository: -``` -$ cd -$ mvn clean package -``` - -The distribution is generated in `/target`. You can then add `/target/powsybl-distribution-/bin` -to your environment variable `PATH`. - -You can now use iTools commands in your terminal: - -``` -$> itools --help -usage: itools [OPTIONS] COMMAND [ARGS] - -Available options are: - --config-name Override configuration file name - -Available commands are: - -Computation: - compare-security-analysis-results Compare security analysis results - loadflow Run loadflow - loadflow-validation Validate load-flow results of a network - security-analysis Run security analysis - -Data conversion: - convert-network convert a network from one format to another - -Misc: - plugins-info List the available plugins - -Script: - run-script run script (only groovy is supported) - -``` -**Optional**: You can set a default configuration by copying the provided configuration file in the `.itools` repository -in your `HOME` (note that you will need to create this repository if it does not exist): -``` -$ mkdir /.itools -$ cp /resources/config/config.yml /.itools/config.yml -``` -This step is not mandatory **if you already have a custom configuration file and the necessary configuration modules are filled**. -For more information, go to the [documentation page of the configuration](https://powsybl.readthedocs.io/projects/powsybl-core/en/latest/user/configuration/index.html). - -**NB**: The pom file used to generate a basic PowSyBl distribution from the sources can be extended in order for the distribution to -allow for more features (even custom features). For more information about how to do it, -go to the [tutorial to create your own iTools packager](../developer/tutorials/itools-packager.md). - -## Run 1st iTools command - -Once your PowSyBl distribution is installed, you will be able to run iTools commands. The `iTools` script provides a command-line interface to interact with PowSyBl. -In other words, you will be able to run command lines from your terminal to use some features from PowSyBl. For more information, -go to the [documentation page of iTools command](itools/index.md). - -### Available features - -The available iTools commands in a basic PowSyBl distribution (installation guide described above) are the following: - - -- [`compare-security-analysis-results`](itools/compare-security-analysis-results.md): Compare results of two security analyses (their violations pre and post contingencies) -- [`convert-network`](itools/convert-network.md): Convert a file describing a network in a given format into another format -- [`loadflow`](itools/loadflow.md): Run a load-flow on a network imported from a file -- [`loadflow-validation`](itools/loadflow-validation.md): Check if a load-flow's results (voltages, angles, flows...) are valid -- [`security-analysis`](itools/security-analysis.md): Run a security analysis on a network imported from a file -- [`plugins-info`](): List the available implementations for each plugins -- [`run-script`](itools/run-script.md): Run a script based on PowSyBl - -### Examples - -#### Converting a UCTE network file to XIIDM - -In this example, you will convert a UCTE file describing the Belgian network to XIIDM format. -The `beTestGridForMerging.uct` file available in `/resources/UCTE` repository will be used. - -Run the following command: -``` -$ itools convert-network --input-file /resources/UCTE/beTestGridForMerging.uct --output-file /beTestGridForMerging --output-format XIIDM -Loading network '/resources/UCTE/beTestGridForMerging.uct' -Generating file /beTestGridForMerging.xiidm... -``` - -Once the command is completed, the XIIDM file describing the Belgian network will be present as `beTestGridForMerging.xiidm` in your `HOME` repository. - -#### Update an XIIDM network file after running a load-flow - -In this example, you will update an XIIDM file describing the example Eurostag network after running a load-flow using `powsybl-open-loadflow`. -The `eurostag-tutorial-example1.xml` file available in `/resources/XIIDM` repository. Please note that this will permanently -change the file. In order to keep it, you can start by copying it: -``` -$ cp /resources/XIIDM/eurostag-tutorial-example1.xml /resources/XIIDM/eurostag-tutorial-example1.xiidm -``` - -Run the following command: -``` -$ itools loadflow --case-file /resources/XIIDM/eurostag-tutorial-example1.xiidm --output-case-file /resources/XIIDM/eurostag-tutorial-example1.xiidm --output-case-format XIIDM -Loading network '/resources/XIIDM/eurostag-tutorial-example1.xiidm' -loadflow results: -+--------+----------------------------------------------------------------------------------------+ -| Result | Metrics | -+--------+----------------------------------------------------------------------------------------+ -| true | {nbIter=5, dureeCalcul=9.25E-4, cause=0, contraintes=0, statut=OK, csprMarcheForcee=0} | -+--------+----------------------------------------------------------------------------------------+ -``` - -Once the command is completed, the `eurostag-tutorial-example1.xiidm` file will be updated to contain post load-flow results, including calculated bus voltage, calculated bus angles and calculated flows. - -## Going further -- [About Configuration](https://powsybl.readthedocs.io/projects/powsybl-core/en/latest/user/configuration/index.html) -- [About iTools commands](itools/index.md) -- [Tutorial to create your own custom iTools command](../developer/tutorials/itools-command.md) -- [Tutorial to create your own iTools packager](../developer/tutorials/itools-packager.md) diff --git a/pages/documentation/user/user-stories/capacity_calculation_rsc.md b/pages/documentation/user/user-stories/capacity_calculation_rsc.md deleted file mode 100644 index ce17e385..00000000 --- a/pages/documentation/user/user-stories/capacity_calculation_rsc.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -layout: default ---- - -# Capacity calculation for RSC - -This user story concerns Regional Security Coordinators (RSCs). An efficient and safe management of the European electricity system requires coordination at regional level. -This is the role of RSCs, whose objectives are the coordinated security of the electricity system, the integration of large-scale renewable energy generation -and the development of the European electricity market. They perform five core services for TSOs: - -- Coordinated security analysis -- Outage planning coordination -- Coordinated capacity allocation -- Short-term and very short-term adequacy forecast -- Individual and common grid modeling and data set delivery - - -We are going to explain how to perform a coordinated capacity computation using PowSyBl and some specific developments. -We want to ensure that flows across borders respect given maximum admissible values, while ensuring electricity security of supply. -If some overloads are reported, a remedial actions optimization is called to find the cheapest solution to solve the constraints. -Remedial actions can be either changing the tap of a PST (it modifies the impedance of the network and so the load-flows) or doing generator redispatching. - -## Workflow - -The first input data of this process is the network model, coming from UCTE or CIM-CGMES European exchange formats. -We also need an object to define the security domain of the network, built from a CRAC file (**C**ontingency list, **R**emedial **A**ctions and additional **C**onstraints): -it contains a contingencies list, the constraints to monitor and the available remedial actions to get rid of the constraints. - -In this process, we also need two computation engines: -- A loadflow computation is launched before and after each contingency to identify overloads. -- A sensitivity analysis: for each border, a sensitivity analysis determines the impact on the flow of a small variation of the PST angle, and that for all PSTs, and determines the impact on the flow of a small variation of the generation, and that for all generators. - -A cost function is built from the previous results of the sensitivity analysis. It is then sent to a solver to find the remedial actions avoiding constraints at a minimal cost. - -A security analysis is performed at the end of the process to validate the set of remedial actions found by the optimization. - -All PowSyBl features used in this workflow are described below with some implementation examples. - -![Workflow](img/capacity_calculation_rsc/Workflow_Capacity_Calculation_RSC.svg){: width="70%" .center-image} - -## Identification of the power system blocks - -This user story involves several features from the PowSyBl framework and some other features that are specific: - -

- -

-The studied network comes from a set of TSOs' networks. The TSOs' networks can be provided in a common TSO exchange format such as UCTE or CIM-CGMES formats. -The following lines of code come format from [powsybl-tutorials](https://github.com/powsybl/powsybl-tutorials/tree/main/cgmes) and illustrate this functionality. - -```java -File fileBe = new File("/path/to/file/MicroGridTestConfiguration_T4_BE_BB_Complete_v2.zip"); -File fileNl = new File("/path/to/file/MicroGridTestConfiguration_T4_NL_BB_Complete_v2.zip"); -``` - -
- -

- -

-Each input file is imported and transformed to an in-memory object representing the network. - -```java -Network networkBe = Importers.loadNetwork(fileBe.toString()); -Network networkNl = Importers.loadNetwork(fileNl.toString()); -``` - -
- -

- -

-A topological merge of the TSOs' networks is done. The following lines of code come from [powsybl-tutorials](https://github.com/powsybl/powsybl-tutorials/tree/main/cgmes) and illustrate this functionality. - -```java -networkBe.merge(networkNl); -``` - -
- -

- -

-Then, flows are computed with a load flow simulator such as OpenLoadFlow or DynaFlow implementations. - -A loadflow is run on the working variant of the in-memory network with a set of parameters. A computation manager `computationManager` (here defined locally) is used. The default parameters are listed [here](../configuration/parameters/LoadFlowParameters.md). Here angles are set to zero and voltages are set to one per unit. We also create a new variant to store the calculated flows. Note that a network variant is close to a state vector and gathers variables such as injections, productions, tap positions, states of buses, etc. - -```java -LoadFlowParameters loadFlowParameters = new LoadFlowParameters().setVoltageInitMode(LoadFlowParameters.VoltageInitMode.DC_VALUES); -LoadFlowResult result = LoadFlow.run(network, loadFlowParameters); -``` -
- -

- -

-The sensitivity analysis module is dedicated to compute the linearized impact of small network variations on the state variables of some elements. The sensitivity computation is fully described [here](../sensitivity/index.md). In this user story, we use this module to compute all coefficients of the cost function. You can use OpenLoadFlow implementation for these computations. - -
- -

- -

-Remedial actions are read from the CRAC file and given to the optimizer which is a specific module. The best set of remedial actions is converted in actions understandable by PowSyBl. The CRAC file also provides the contingency list, which is also converted to an understandable object for PowSyBl called [Contingency](../contingencies/index.md). - - - -
- -

- -

-The final set of remedial actions is validated through a security analysis. A security analysis needs an input variant, a set of parameters as a `securityAnalysisParameters` object and a set of contingencies through a list. - -```java - -``` - -## External features are: - -

- -

-The cost function builder is in fact a big toolbox using some power system blocks from the PowSyBl framework. For more details about this builder, please refer to [FARAO website](https://farao-community.github.io/). The Google OR-Tools open source library is used to perform the optimization: please visit this [page for more details](https://developers.google.com/optimization/). - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Compute_LF.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Compute_LF.svg deleted file mode 100644 index b97a7f5b..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Compute_LF.svg +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - LF - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Compute_Optimizer.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Compute_Optimizer.svg deleted file mode 100644 index 5167f8b6..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Compute_Optimizer.svg +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - Optimizer - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Compute_SA.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Compute_SA.svg deleted file mode 100644 index 706b5b22..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Compute_SA.svg +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - SA - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Compute_Sensitivity.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Compute_Sensitivity.svg deleted file mode 100644 index 3256deee..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Compute_Sensitivity.svg +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - Sensitivity - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Export.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Export.svg deleted file mode 100644 index a9ea3566..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Export.svg +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/File.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/File.svg deleted file mode 100644 index 89171559..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/File.svg +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Import.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Import.svg deleted file mode 100644 index 613045f5..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Import.svg +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Modify_N-1.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Modify_N-1.svg deleted file mode 100644 index f6d87da6..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Modify_N-1.svg +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - N-1 - - - - - N-1 - - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Modify_iAL.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Modify_iAL.svg deleted file mode 100644 index 15324fec..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Modify_iAL.svg +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - iAL - - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Network.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Network.svg deleted file mode 100644 index 2d94ee80..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Network.svg +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Network_Simple_Final.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Network_Simple_Final.svg deleted file mode 100644 index ce256b02..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Network_Simple_Final.svg +++ /dev/null @@ -1,217 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 611,4 - 610,6 - 601 - 600 - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Network_Simple_Initial.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Network_Simple_Initial.svg deleted file mode 100644 index 68f44a2e..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Network_Simple_Initial.svg +++ /dev/null @@ -1,239 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 606,5 - 302,4 - 302,4 - 300,4 - 300,4 - 600 - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Network_extract.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Network_extract.svg deleted file mode 100644 index 60d0cc85..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Network_extract.svg +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - extract - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Network_merging.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Network_merging.svg deleted file mode 100644 index daf6955b..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Network_merging.svg +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - merging - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Workflow.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Workflow.svg deleted file mode 100644 index 73090b2e..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Workflow.svg +++ /dev/null @@ -1,459 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - LF - - - - N-1 - - - - - LF - - - - - - - - - - - - - - - - Final state - - - - - - - - - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Workflow_Capacity_Calculation_RSC.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Workflow_Capacity_Calculation_RSC.svg deleted file mode 100644 index 1f830966..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/Workflow_Capacity_Calculation_RSC.svg +++ /dev/null @@ -1,704 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - CGMESUCTE - - - LF - - - - - - - - - CRAC - - - Sensitivity - - - - - - - - - - - merging - - - - Action - - - - - - - SA - - - Optimizer - Bestremedialactions - - - - - - - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/[Process]N-1Eurostag.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/[Process]N-1Eurostag.svg deleted file mode 100644 index 280fec2c..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/[Process]N-1Eurostag.svg +++ /dev/null @@ -1,1492 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 606,5 - 302,4 - 302,4 - 300,4 - 300,4 - 600 - - - - - - - - - - - - - - - - - - - - - - - - 611,4 - 610,6 - 601 - 600 - - - - - - - - - - - - - - - - - - - - - - - - - - - merging - - - - - - - - - - - extract - - - - LF - - - - SA - - - - Sensitivity - - - - iAL - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 606,5 - 302,4 - 302,4 - 300,4 - 300,4 - 600 - - - - - - - - - - - - - - - - - - - - - - - - 611,4 - 610,6 - 601 - 600 - - - - - LF - - - - - N-1 - - - - - - LF - - - - - - - - - - - - - - - - Final state - - - - N-1 - - - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/busBreakerTopology.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/busBreakerTopology.svg deleted file mode 100644 index bcc62705..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/busBreakerTopology.svg +++ /dev/null @@ -1,395 +0,0 @@ - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/busTopology.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/busTopology.svg deleted file mode 100644 index 2546923d..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/busTopology.svg +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/nodeBreakerTopology.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/nodeBreakerTopology.svg deleted file mode 100644 index c8428ddf..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/nodeBreakerTopology.svg +++ /dev/null @@ -1,675 +0,0 @@ - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/nodeBreakerTopologyGraph.svg b/pages/documentation/user/user-stories/img/capacity_calculation_rsc/nodeBreakerTopologyGraph.svg deleted file mode 100644 index 179f034b..00000000 --- a/pages/documentation/user/user-stories/img/capacity_calculation_rsc/nodeBreakerTopologyGraph.svg +++ /dev/null @@ -1,1126 +0,0 @@ - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - BBS2 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/pages/documentation/user/user-stories/index.md b/pages/documentation/user/user-stories/index.md deleted file mode 100644 index 476f6c95..00000000 --- a/pages/documentation/user/user-stories/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -layout: default ---- - -# User stories -You'll find here the description of user stories based on PowSyBl: -- [How to calculate capacity for a Regional Security Center?](capacity_calculation_rsc.md) diff --git a/pages/overview/getting-started.html b/pages/overview/getting-started.html index dee59e4a..a35789f1 100644 --- a/pages/overview/getting-started.html +++ b/pages/overview/getting-started.html @@ -10,7 +10,6 @@ -

You can also find all our "getting started" resources here. Some of them are highlighted below.