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.

Sign up for GitHub

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

[Shortcircuit] Add some documentation about the voltage attribute of voltage ranges. #3226

Merged
merged 2 commits into from
Nov 27, 2024
Merged

[Shortcircuit] Add some documentation about the voltage attribute of voltage ranges. #3226

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3eb600d
Add some documentation about voltage attribute of voltage ranges.
colinepiloquet Nov 25, 2024
383d099
Merge branch 'main' into add_doc_about_voltage_in_voltage_range
olperr1 Nov 27, 2024
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
16 changes: 11 additions & 5 deletions docs/simulation/shortcircuit/parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,25 +106,31 @@ This property defines the voltage profile that should be used for the calculatio
**voltage-ranges**

This property specifies a path to a JSON file containing the voltage ranges and associated coefficients to be used when `initial-voltage-profile-mode` is set to `CONFIGURED`.
The JSON file must contain a list of voltage ranges and coefficients. Then, for each nominal voltage in the network that belongs to the range, the given coefficient is applied to calculate the voltage to be used
in the calculation. All the coefficients should be between 0.8 and 1.2.
The JSON file must contain a list of voltage ranges and for each range, coefficients and/or voltages.
Then, for each nominal voltage in the network that belongs to the range, the coefficient is applied to calculate the voltage to be used
in the calculation. All the coefficients should be between 0.8 and 1.2. They are optional, and if they are missing for a range, 1 will be used.
The voltage attribute of the voltage range defines the nominal voltage of all the voltage levels in the network that are in the range.
It is also optional, and if it is not defined, then the nominal voltage already in the network will be used.
Here is an example of this JSON file:
````json
[
{
"minimumNominalVoltage": 350.0,
"maximumNominalVoltage": 400.0,
"voltageRangeCoefficient": 1.1
"voltageRangeCoefficient": 1.1,
"voltage": 380.0
},
{
"minimumNominalVoltage": 215.0,
"maximumNominalVoltage": 235.0,
"voltageRangeCoefficient": 1.2
"voltageRangeCoefficient": 1.2,
"voltage": 225.0
},
{
"minimumNominalVoltage": 80.0,
"maximumNominalVoltage": 150.0,
"voltageRangeCoefficient": 1.05
"voltageRangeCoefficient": 1.05,
"voltage": 105.0
}
]
````
Expand Down