From 1608493d89d0ac9e9398adb1ad03b64097c4fc78 Mon Sep 17 00:00:00 2001 From: Sophie Frasnedo Date: Wed, 22 Jan 2025 15:17:09 +0100 Subject: [PATCH] Add mention of GeneratorStartup to ReadTheDocs Signed-off-by: Sophie Frasnedo --- docs/grid_model/extensions.md | 26 ++++++++++++++++++++++++++ docs/grid_model/network_subnetwork.md | 1 + 2 files changed, 27 insertions(+) diff --git a/docs/grid_model/extensions.md b/docs/grid_model/extensions.md index 0a77019b8a9..8a6019b8393 100644 --- a/docs/grid_model/extensions.md +++ b/docs/grid_model/extensions.md @@ -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 diff --git a/docs/grid_model/network_subnetwork.md b/docs/grid_model/network_subnetwork.md index 5fa412ee1f7..507c0b016ae 100644 --- a/docs/grid_model/network_subnetwork.md +++ b/docs/grid_model/network_subnetwork.md @@ -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)