Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Draft] Move configuration docs #3121

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions docs/user/configuration/computation-local.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
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
<computation-local>
<available-core>1</available-core>
<tmp-dir>/home/user/tmp:/tmp</tmp-dir>
</computation-local>
```
35 changes: 35 additions & 0 deletions docs/user/configuration/default-computation-manager.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
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
<default-computation-manager>
<long-time-execution-computation-manager-factory>com.powsybl.computation.local.LocalComputationManagerFactory</long-time-execution-computation-manager-factory>
<short-time-execution-computation-manager-factory>com.powsybl.computation.local.LocalComputationManagerFactory</short-time-execution-computation-manager-factory>
</default-computation-manager>
```
26 changes: 26 additions & 0 deletions docs/user/configuration/network.md
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am wondering if this still exists.

Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
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
<network>
<default-impl-name>Default</default-impl-name>
</network>
```
75 changes: 75 additions & 0 deletions docs/user/configuration/simulation-parameters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
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
<simulation-parameters>
<preFaultSimulationStopInstant>0.1</preFaultSimulationStopInstant>
<faultEventInstant>0.2</faultEventInstant>
<branchSideOneFaultShortCircuitDuration>0.35</branchSideOneFaultShortCircuitDuration>
<branchSideTwoFaultShortCircuitDuration>0.75</branchSideTwoFaultShortCircuitDuration>
<generatorFaultShortCircuitDuration>0.3</generatorFaultShortCircuitDuration>
<postFaultSimulationStopInstant>0.8</postFaultSimulationStopInstant>
</simulation-parameters>
```
47 changes: 47 additions & 0 deletions docs/user/configuration/table-formatter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
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
<table-formatter>
<invalidString>inv</invalidString>
<language>FR</language>
<printHeader>true</printHeader>
<printTitle>true</printTitle>
<separator>;</separator>
</table-formatter>
```