diff --git a/NEWS.md b/NEWS.md index 403548f5..e42b657f 100644 --- a/NEWS.md +++ b/NEWS.md @@ -28,9 +28,14 @@ BUGFIXES : * `updateOutputSettings()` : in API mode, allow the user to edit the desired property -OTHER UPDATES : -* `updateGeneralSettings()` : replace custom.ts.numbers argument by custom.scenario and deprecate custom.ts.numbers -* `updateGeneralSettings()` : add thematic.trimming argument for edition +OTHER UPDATES : + +* `updateGeneralSettings()` : replace custom.ts.numbers argument by custom.scenario and deprecate custom.ts.numbers +* `updateGeneralSettings()` : add thematic.trimming argument for edition + +DOC : + +* `createClusterST()` : update doc to discrabe st-storage list parameters + "Inflows" parameter # antaresEditObject 0.7.0 diff --git a/R/createClusterST.R b/R/createClusterST.R index 7c13a792..0b26c98e 100644 --- a/R/createClusterST.R +++ b/R/createClusterST.R @@ -20,7 +20,21 @@ #' @template opts #' @note #' To write parameters to the `list.ini` file. You have function `storage_values_default()` who is called by default. -#' This function return `list` containing properties according study version for cluster `st-storage`. +#' This function return `list` containing properties according study version for cluster `st-storage`. +#' +#' Study version >= "8.6.0" : +#' - efficiency = 1 (`numeric` \{0;1\}) +#' - reservoircapacity = 0 (`integer` >= 0) +#' - initiallevel = 0 (`numeric` \{0;1\}) +#' - withdrawalnominalcapacity = 0 (`integer` >= 0) +#' - injectionnominalcapacity = 0 (`integer` >= 0) +#' - initialleveloptim = FALSE (`logical` TRUE/FALSE) +#' +#' +#' Study version >= "8.8.0" (update + new parameter) : +#' - initiallevel = 0.5 (`numeric` \{0;1\}) +#' - enabled = TRUE (`logical` TRUE/FALSE) +#' #' See example section. #' #' To write data (.txt file), you have parameter for each output file : diff --git a/man/createClusterST.Rd b/man/createClusterST.Rd index c52860c0..bc4b0de7 100644 --- a/man/createClusterST.Rd +++ b/man/createClusterST.Rd @@ -56,6 +56,23 @@ Create a new ST-storage cluster for >= v8.6.0 Antares studies. \note{ To write parameters to the \code{list.ini} file. You have function \code{storage_values_default()} who is called by default. This function return \code{list} containing properties according study version for cluster \code{st-storage}. + +Study version >= "8.6.0" : +\itemize{ +\item efficiency = 1 (\code{numeric} \{0;1\}) +\item reservoircapacity = 0 (\code{integer} >= 0) +\item initiallevel = 0 (\code{numeric} \{0;1\}) +\item withdrawalnominalcapacity = 0 (\code{integer} >= 0) +\item injectionnominalcapacity = 0 (\code{integer} >= 0) +\item initialleveloptim = FALSE (\code{logical} TRUE/FALSE) +} + +Study version >= "8.8.0" (update + new parameter) : +\itemize{ +\item initiallevel = 0.5 (\code{numeric} \{0;1\}) +\item enabled = TRUE (\code{logical} TRUE/FALSE) +} + See example section. To write data (.txt file), you have parameter for each output file :