diff --git a/dev/pkgdown.yml b/dev/pkgdown.yml index ccc72260..c7e8e96d 100644 --- a/dev/pkgdown.yml +++ b/dev/pkgdown.yml @@ -7,4 +7,4 @@ articles: api-variant-management: api-variant-management.html renewables-energy-sources: renewables-energy-sources.html scenario-builder: scenario-builder.html -last_built: 2024-08-21T13:59Z +last_built: 2024-08-30T14:23Z diff --git a/dev/reference/createClusterST.html b/dev/reference/createClusterST.html index 69e04113..19720973 100644 --- a/dev/reference/createClusterST.html +++ b/dev/reference/createClusterST.html @@ -106,7 +106,8 @@

Arguments

group
-

Group of the cluster, one of : "PSP_open", "PSP_closed", "Pondage", "Battery", "Other". It corresponds to the type of stockage.

+

Group of the cluster, one of : "PSP_open", "PSP_closed", "Pondage", "Battery", "Other". +It corresponds to the type of stockage.

storage_parameters
@@ -114,23 +115,24 @@

Arguments

PMAX_injection
-

modulation of charging capacity on an 8760-hour basis. The values are float between 0 and 1.

+

Modulation of charging capacity on an 8760-hour basis. numeric {0;1} (8760*1).

PMAX_withdrawal
-

modulation of discharging capacity on an 8760-hour basis. The values are float between 0 and 1.

+

Modulation of discharging capacity on an 8760-hour basis. numeric {0;1} (8760*1).

inflows
-

Algebraic deviation of the state of charge of the storage, which does not induce any power generation or consumption on the system.

+

Algebraic deviation of the state of charge of the storage, which does not induce any power +generation or consumption on the system numeric {<0;>0} (8760*1).

lower_rule_curve
-

This is the lower limit for filling the stock imposed each hour. The values are float between 0 and 1.

+

This is the lower limit for filling the stock imposed each hour. numeric {0;1} (8760*1).

upper_rule_curve
-

This is the upper limit for filling the stock imposed each hour. The values are float between 0 and 1.

+

This is the upper limit for filling the stock imposed each hour. numeric {0;1} (8760*1).

add_prefix
@@ -162,17 +164,14 @@

Note

  • initialleveloptim = FALSE (logical TRUE/FALSE)

    • Study version >= "8.8.0" (update + new parameter) :

    See example section.

    -

    To write data (.txt file), you have parameter for each output file :

    +

    ⚠⚠⚠

    +

    By default, these values don't allow you to have an active cluster (See example section.)

    +

    ⚠⚠⚠

    +

    See also

    -

    editClusterST() to edit existing clusters, antaresRead::readClusterSTDesc() to read cluster, -removeClusterST() to remove clusters.

    +

    All the functions needed to manage a storage cluster, +antaresRead::readClusterSTDesc(), editClusterST(), removeClusterST().

    @@ -193,13 +192,19 @@

    Examples

    # > "my_area_my_cluster" # create cluster with custom parameter and data + # use the function to create your own list of parameters (no Antares optim) + # if you want optim (my_parameters$initialleveloptim <- TRUE) my_parameters <- storage_values_default() my_parameters$efficiency <- 0.5 +my_parameters$initiallevel <- 10 +my_parameters$withdrawalnominalcapacity <- 100 +my_parameters$injectionnominalcapacity <- 1000 my_parameters$reservoircapacity <- 10000 - + # time series inflow_data <- matrix(3, 8760) ratio_data <- matrix(0.7, 8760) + createClusterST(area = "my_area", "my_cluster", storage_parameters = my_parameters,