Update documentation

Author: Juliette-Gerbaux

R/Grid_Matrix.R

@@ -52,6 +52,10 @@
 #' @param controls_reward_calculation If method_old_gain=F, vector of controls evaluated
 #' @param max_hydro_hourly Hourly maximum pumping and turbining powers
 #' @param max_hydro_weekly Weekly maximum pumping and turbining powers
+#' @param force_final_level Binary. Whether final level should be constrained
+#' @param final_level_egal_initial Binary. Whether final level, if constrained, should be equal to initial level
+#' @param final_level Final level (in percent between 0 and 100) if final level is constrained but different from initial level
+#' @param penalty_final_level Penalties (for both bottom and top rule curves) to constrain final level
 #'
 #' @return List of a data.frame with aggregated water values and
 #' a data.frame of more detailed water values

R/Plot_functions.R

@@ -182,6 +182,8 @@ plot_reward_variation_mc <- function(reward_base,week_id,Mc_year)
 #' @param penalty_low Penalty for the lower rule curve
 #' @param penalty_high Penalty for the higher rule curve
 #' @param week_number Numeric of length 1. number of the week to plot.
+#' @param force_final_level Binary. Whether final level should be constrained
+#' @param penalty_final_level Penalties (for both bottom and top rule curves) to constrain final level
 #'
 #' @return a \code{ggplot} object
 #' @export

R/functions.R

@@ -227,6 +227,8 @@ getSimulationNames <- function(pattern, studyPath = NULL, opts = antaresRead::si
 #' @param penalty_level_low Penalty for violating the bottom rule curve, comparable to the unsupplied energy cost
 #' @param penalty_level_high Penalty for violating the top rule curve, comparable to the spilled energy cost
 #' @param constant Boolean. Generate daily constant values by week. FALSE to do interpolation.
+#' @param force_final_level Boolean. Whether final level should be constrained
+#' @param penalty_final_level Penalties (for both bottom and top rule curves) to constrain final level
 #'
 #' @return A 365*101 numeric matrix
 #' @export

R/math_functions.R

@@ -7,6 +7,8 @@
 #' @param reservoir Data frame describing rule curves, generated by \code{readReservoirLevels}
 #' @param penalty_level_high Penalty for violating the bottom rule curve
 #' @param penalty_level_low Penalty for violating the top rule curve
+#' @param force_final_level Binary. Whether final level should be constrained
+#' @param penalty_final_level Penalties (for both bottom and top rule curves) to constrain final level
 #'
 #' @return Data frame with water value (vu) for each week (weeks) and each state (states).
 #' vu_pen corresponds to water value without penalties

R/post_process.R

@@ -9,6 +9,8 @@
 #' @param max maximal accepted water value
 #' @param penalty_level_high Penalty for violating top rule curve
 #' @param penalty_level_low Penalty for violating bottom rule curve
+#' @param force_final_level Binary. Whether final level should be constrained
+#' @param penalty_final_level Penalties (for both bottom and top rule curves) to constrain final level
 #'
 #' @return a \code{data.table}
 #' @export

R/readReservoirLevels.R

@@ -6,6 +6,9 @@
 #' @param opts
 #'   List of simulation parameters returned by the function
 #'   \code{antaresRead::setSimulationPath}
+#' @param force_final_level Binary. Whether final level should be constrained
+#' @param final_level_egal_initial Binary. Whether final level, if constrained, should be equal to initial level
+#' @param final_level Final level (in percent between 0 and 100) if final level is constrained but different from initial level
 #'
 #' @return a data.table
 #' @export

R/shiny_calculate.R

@@ -382,7 +382,7 @@ calculateServer <- function(id, opts, silent) {
       if(is.null(simulation_res())){"Monte Carlo years :"}
       else {
         paste0("Monte Carlo years : from ",simulation_res()$mc_years[1], " to ",
-               tail(simulation_res()$mc_years,n=1))}
+               utils::tail(simulation_res()$mc_years,n=1))}
     })
 
     constraints <- shiny::reactive({

README.Rmd

@@ -107,11 +107,26 @@ results <- Grid_Matrix(
                                                      nb_disc_stock = 20,
                                                      pumping = pumping,
                                                      pumping_efficiency = pump_eff,
-                                                     opts=opts)# used for marginal prices interpolation
+                                                     opts=opts),# used for marginal prices interpolation
+  force_final_level = F # T if you want to constrain final level with penalties (see Grid_Matrix documentation for more information)
 )
 aggregated_results <- results$aggregated_results
 ```
 
+Water values are written to Antares thanks to the following instructions
+
+```{r eval=FALSE}
+reshaped_values <- aggregated_results[aggregated_results$weeks!=53,] %>%
+  to_Antares_Format(penalty_level_low=3,
+                    penalty_level_high=0,
+                    force_final_level=F,
+                    penalty_final_level=0)
+antaresEditObject::writeWaterValues(
+  area = area,
+  data = reshaped_values
+)
+```
+
 You can plot the results
 
 ```{r, include=FALSE}
@@ -127,7 +142,10 @@ waterValuesViz(Data=aggregated_results,filter_penalties = F)
 plot_Bellman(value_nodes_dt = aggregated_results, 
              week_number = c(1,3),
              penalty_high = 0,
-             penalty_low = 3)
+             penalty_low = 3,
+             force_final_level = F, #T if final level is constrained
+             penalty_final_level = 0 # used if final level is constrained
+             )
 ```
 
 You can also plot reward functions

README.md

@@ -100,11 +100,26 @@ results <- Grid_Matrix(
                                                      nb_disc_stock = 20,
                                                      pumping = pumping,
                                                      pumping_efficiency = pump_eff,
-                                                     opts=opts)# used for marginal prices interpolation
+                                                     opts=opts),# used for marginal prices interpolation
+  force_final_level = F # T if you want to constrain final level with penalties (see Grid_Matrix documentation for more information)
 )
 aggregated_results <- results$aggregated_results
 ```
 
+Water values are written to Antares thanks to the following instructions
+
+``` r
+reshaped_values <- aggregated_results[aggregated_results$weeks!=53,] %>%
+  to_Antares_Format(penalty_level_low=3,
+                    penalty_level_high=0,
+                    force_final_level=F,
+                    penalty_final_level=0)
+antaresEditObject::writeWaterValues(
+  area = area,
+  data = reshaped_values
+)
+```
+
 You can plot the results
 
 ``` r
@@ -117,7 +132,10 @@ waterValuesViz(Data=aggregated_results,filter_penalties = F)
 plot_Bellman(value_nodes_dt = aggregated_results, 
              week_number = c(1,3),
              penalty_high = 0,
-             penalty_low = 3)
+             penalty_low = 3,
+             force_final_level = F, #T if final level is constrained
+             penalty_final_level = 0 # used if final level is constrained
+             )
 ```
 
 <img src="man/figures/README-bellman-1.png" width="100%" />