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

Add mention of GeneratorStartup to ReadTheDocs #3285

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+27 −0
Open

Add mention of GeneratorStartup to ReadTheDocs #3285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 26 additions & 0 deletions docs/grid_model/extensions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,32 @@ generator.newExtension(GeneratorShortCircuitAdder.class)
.add();
```

(generator-startup)=
## Generator startup

This extension contains the information related to the startup of a generator.

| Attribute | Type | Unit | Required | Default value | Description |
|----------------------------|--------|------|----------|---------------|-----------------------------------------------------------------|
| forcedOutageRate | double | - | no | - | Rate of forced unavailability |
| marginalCost | double | - | no | - | Cost to increase the production of one unit (in general one MW) |
| plannedActivePowerSetpoint | double | MW | no | - | Active power target planned by the market |
| plannedOutageRate | double | - | no | - | Rate of planned unavailability |
| startupCost | double | - | no | - | Cost to start the generator |

This extension is provided in the `com.powsybl:powsybl-iidm-extensions` module.

To add this extension to a generator, the code to be used is:
```java
generator.newExtension(GeneratorStartupAdder.class)
.withPlannedActivePowerSetpoint(600.0)
.withStartupCost(5.0)
.withMarginalCost(10.0)
.withPlannedOutageRate(0.8)
.withForcedOutageRate(0.7)
.add();
```

(identifiable-short-circuit-extension)=
## Identifiable short-circuit

Expand Down
1 change: 1 addition & 0 deletions docs/grid_model/network_subnetwork.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,7 @@ The `isCondenser` value corresponds for instance to generators which can control
- [Discrete Measurements](extensions.md#discrete-measurements)
- [Generator ENTSO-E Category](extensions.md#generator-entso-e-category)
- [Generator Short-Circuit](extensions.md#generator-short-circuit)
- [Generator Startup](extensions.md#generator-startup)
- [Injection Observability](extensions.md#injection-observability)
- [Measurements](extensions.md#measurements)
- [Remote Reactive Power Control](extensions.md#remote-reactive-power-control)
Expand Down
Loading