R/shiny_calculate.R

In rte-antares-rpackage/antaresWaterValues: Generating water values for Antares

calculateUI <- function(id, opts) {
  shiny::sidebarLayout(
    shiny::sidebarPanel(
      shiny::h1("Calculate watervalues"),
      shiny::h2("Study parameters"),

      shiny::fileInput(NS(id,"ini_file"), label = "Rdata file containing the simulations"),
      shinyBS::bsTooltip(
        NS(id,"ini_file"),
        " Select the Rdata file that contains the simulation results.",
        "bottom"
      ),

      #area
      shiny::textOutput(
        NS(id,"Area")),
      shinyBS::bsTooltip(
        NS(id,"Area"),
        "The area for which you will calculate the water values.",
        "bottom"
      ),

      shiny::textOutput(
        NS(id,"pumping_cal")),
      shinyBS::bsTooltip(
        NS(id,"pumping_cal"),
        "Whether pumping is possible."
      ),

      #MC years:
      shiny::textOutput(
        NS(id,"mcyears")),

      shinyBS::bsTooltip(
        NS(id,"mcyears"),
        " Monte-Carlo years considered in water values calculation.",
        "bottom"
      ),

      shiny::h2("Bellman values calculation"),

      #number of states:
      shiny::sliderInput(
        NS(id,"nb_states"),
        label = "Choose the number of states",
        min = 5,
        max = 100,
        value = 40,
        step = 1
      ),
      shinyBS::bsTooltip(
        NS(id,"nb_states"),
        " Discretization ratio to generate steps levels between the reservoir capacity and zero.",
        "bottom"
      ),

      # penalty for violation of the bottom rule curve
      shiny::numericInput(
        NS(id,"penalty_low"),
        "Penalty for the violation of the bottom rule curve (euros/MWh)",
        value = 3001
      ),
      shinyBS::bsTooltip(
        NS(id,"penalty_low"),
        "Penalty will be added proportionally to the distance from the rule curve, it is directly comparable with the cost of unsupplied energy.",
        "bottom"
      ),

      # penalty for violation of the top rule curve
      shiny::numericInput(
        NS(id,"penalty_high"),
        "Penalty for the violation of the top rule curve (euros/MWh)",
        value = 0
      ),
      shinyBS::bsTooltip(
        NS(id,"penalty_high"),
        "Penalty will be added proportionally to the distance from the rule curve, it is directly comparable with the cost of spilled energy.",
        "bottom"
      ),

      shinyWidgets::materialSwitch(
        NS(id,"force_final_level"),
        "Force final level",
        value = F,
        status = "success"
      ) %>%
        bsplus::shinyInput_label_embed(
          bsplus::shiny_iconlink() %>%
            bsplus::bs_embed_popover(title = "This option modifies rule curves in the calculation to force the final level to be egal to the initial level. There is no hard constraint in simulation, only penalties as defined below.")
        ),

      shiny::conditionalPanel(
        ns = NS(id),
        condition = "input.force_final_level",
        shinyWidgets::materialSwitch(
          NS(id,"final_level_exact"),
          "Final level should be respected for all scenarios (if not consider expectancy)",
          value = T,
          status = "success"
        ) %>%
          bsplus::shinyInput_label_embed(
            bsplus::shiny_iconlink() %>%
              bsplus::bs_embed_popover(
                title ="If true, penalties ensure that the final level is met, if not the expectancy of final levels should be equal to the objective and there is no hard constraint.")),
        ),

      shiny::conditionalPanel(
        ns = NS(id),
        condition = "input.force_final_level",
        shinyWidgets::materialSwitch(
          NS(id,"final_level_egal_initial"),
          "Final level should be equal to initial level",
          value = T,
          status = "success"
        ) %>%
          bsplus::shinyInput_label_embed(
            bsplus::shiny_iconlink() %>%
              bsplus::bs_embed_popover(title ="If the final level should be equal to the initial level. There could be a deviation of the final level to the closest integer due to the implementation of penalties through water values.")),
        shiny::numericInput(
          NS(id,"penalty_final_level_high"),
          "Penalty for final level (top rule curve)",
          value = 3001
        ),
        shiny::numericInput(
          NS(id,"penalty_final_level_low"),
          "Penalty for final level (bottom rule curve)",
          value = 3001
        ),
      ),

      shinyBS::bsTooltip(
        NS(id,"penalty_final_level_low"),
        "Penalty will be added proportionally to the distance from the expected final level.",
        "bottom"
      ),

      shinyBS::bsTooltip(
        NS(id,"penalty_final_level_high"),
        "Penalty will be added proportionally to the distance from the expected final level.",
        "bottom"
      ),

      shiny::conditionalPanel(
        ns = NS(id),
        condition = "!input.final_level_egal_initial",
        shiny::numericInput(
          NS(id,"final_level"),
          "Final level (%)",
          value = 0
        ),
      ),

      shinyBS::bsTooltip(
        NS(id,"final_level"),
        "There could be a deviation of the final level to the closest integer.",
        "bottom"
      ),


      shiny::actionButton(
        NS(id,"Calculate"),
        "Launch calculation",
        icon = shiny::icon("check-circle"),
        align = "center"
      ),
      shinyBS::bsTooltip(
        NS(id,"Calculate"),
        "Click to start the calculation of te water values using the selected parameters",
        "bottom"
      ),
      shiny::h2("Plot"),

      shinyWidgets::materialSwitch(
        NS(id,"filter"),
        "Filter water values",
        value = F,
        status = "success"
      ) %>%
        bsplus::shinyInput_label_embed(
          bsplus::shiny_iconlink() %>%
            bsplus::bs_embed_popover(title = "Visualize only watervalues inside rule curves")
        ),


      shiny::actionButton(NS(id,"plot"), "Show"),
      shinyBS::bsTooltip(NS(id,"plot"), " Show the Graph",
                         "bottom"),
    ),

    shiny::mainPanel(
      shinycustomloader::withLoader(
        shiny::plotOutput(NS(id,"Watervalues")),
        type = "html",
        loader = "dnaspin"
      ),
      shinyWidgets::downloadBttn(
        outputId = NS(id,"download_wv_plot"),
        style = "unite",
        color = "primary",
        block = T
      ),

    )
  )
}

calculateServer <- function(id, opts, silent) {
  moduleServer(id, function(input, output, session) {
    res <- shiny::reactiveValues()

    simulation_res <- shiny::reactive({
      if (is.null(input$ini_file)) {
        NULL
      } else{
        inFile <- input$ini_file
        file <- inFile$datapath
        # load the file into new environment and get it from there
        e = new.env()
        name <- load(file, envir = e)
        simulation_res <- e[[name]]
        simulation_res
      }
    })

    output$Area <- shiny::renderText({
      if(is.null(simulation_res())){"Area :"}
      else paste0("Area : ",simulation_res()$area)})

    output$pumping_cal <- shiny::renderText({
      if(is.null(simulation_res())){"Pumping :"}
      else {
        if(simulation_res()$pumping) {
          paste0("Pumping : yes with efficiency ",simulation_res()$eff)}
        else {
          "Pumping : no"
        }
      }
    })

    output$mcyears <- shiny::renderText({
      if(is.null(simulation_res())){"Monte Carlo years :"}
      else {
        paste0("Monte Carlo years : from ",simulation_res()$mc_years[1], " to ",
               utils::tail(simulation_res()$mc_years,n=1))}
    })

    constraints <- shiny::reactive({
      if ("mcYear" %in% names(simulation_res()$simulation_values)){
        constraint_generator(
          area = simulation_res()$area,
          opts = opts,
          pumping = simulation_res()$pumping,
          nb_disc_stock = 20,
          pumping_efficiency = simulation_res()$eff,
          mcyears = simulation_res()$mc_years
        ) %>%
          dplyr::cross_join(data.frame(mcYear=simulation_res()$mc_years))
      }
      else {
        constraint_generator(
          area = simulation_res()$area,
          opts = opts,
          pumping = simulation_res()$pumping,
          nb_disc_stock = 20,
          pumping_efficiency = simulation_res()$eff,
          mcyears = simulation_res()$mc_years
        )
      }
    })

    possible_controls <- shiny::reactive({
      if ("mcYear" %in% names(simulation_res()$simulation_values)){
        rbind(
          simulation_res()$simulation_values,
          constraints()
        ) %>%
          dplyr::select("week", "u","mcYear") %>%
          dplyr::distinct() %>%
          dplyr::arrange(.data$mcYear,week, .data$u)
      }
      else {
        rbind(
          simulation_res()$simulation_values,
          constraints()
        ) %>%
          dplyr::select("week", "u") %>%
          dplyr::distinct() %>%
          dplyr::arrange(week, .data$u)
      }

    })

    final_lvl <- shiny::reactive({if (input$force_final_level){
      if (input$final_level_egal_initial|is.null(input$final_level)){
        final_lvl <- readReservoirLevels(simulation_res()$area, timeStep = "daily",
                                         byReservoirCapacity = FALSE,
                                         opts = opts)[1,]
        assertthat::assert_that(final_lvl$level_low==final_lvl$level_high,
                                msg = "Initial level is not defined properly in the Antares study. Please correct it by setting level_low and level_high equals for the first day of the year.")
        final_lvl$level_low*100
      } else {
        input$final_level
      }
    }
  })

    shiny::observeEvent(input$Calculate,

                        spsUtil::quiet({
                          spsComps::shinyCatch({
                            reward_db <-
                              get_Reward(
                                simulation_names = simulation_res()$simulation_names,
                                simulation_values = simulation_res()$simulation_values,
                                district_name = "water values district",
                                opts = opts,
                                method_old = F,
                                hours = round(seq(0, 168, length.out = 10)),
                                possible_controls = possible_controls(),
                                max_hydro = get_max_hydro(simulation_res()$area, opts),
                                mcyears = simulation_res()$mc_years,
                                area = simulation_res()$area,
                                district_balance = "water values district"
                              )

                            results <-     Grid_Matrix(
                              area = simulation_res()$area,
                              reward_db = reward_db,
                              simulation_names = simulation_res()$simulation_names,
                              simulation_values = simulation_res()$simulation_values,
                              nb_cycle = if(!input$final_level_exact|!input$force_final_level){2}else{1},
                              opts = opts,
                              week_53 = 0,
                              district_name = "water values district" ,
                              method = "grid-mean",
                              states_step_ratio = (1 / input$nb_states),
                              mcyears = simulation_res()$mc_years,
                              shiny = T,
                              until_convergence = F,
                              pumping = simulation_res()$pumping,
                              efficiency = simulation_res()$eff,
                              correct_concavity = F,
                              correct_monotony_gain = F,
                              penalty_low = input$penalty_low,
                              penalty_high = input$penalty_high,
                              force_final_level = input$force_final_level,
                              final_level = final_lvl(),
                              penalty_final_level_low = input$penalty_final_level_low,
                              penalty_final_level_high = input$penalty_final_level_high
                            )$aggregated_results

                            shiny::isolate(res$results <- results)
                            shiny::isolate(res$reward_db <- reward_db)
                            shinyWidgets::show_alert(title = "Water Values",
                                                     text = "Calculation Done !!",
                                                     type = "success")


                          }, blocking_level = "error", position = "top-center", shiny = TRUE, prefix = "")

                        }, print_cat = F, message = F, warning = silent))





    watervalues <- shiny::eventReactive(input$plot,
                                        {
                                          waterValuesViz(res$results, input$filter)
                                        })

    output$Watervalues <- shiny::renderPlot(watervalues())

    shinyBS::addPopover(session,
                        "Watervalues",
                        title = "water values",
                        content = "This graph describe the water values for each week starting from week 1 to week 52 in the X-axis and the level of the reservoir in perecent in the Y-axis. the water values are determined by the colors you can see them in the legend of the graph. ")

    output$download_wv_plot <- shiny::downloadHandler(
      filename = function() {
        paste('watervalues-', Sys.Date(), '.png', sep = '')
      },
      content = function(con) {
        grDevices::png(con , width = 1200,
                       height = 766)
        print(watervalues())
        grDevices::dev.off()
      }
    )

    list(
      watervalues = reactive(res$results),
      reward_db = reactive(res$reward_db),
      area = reactive(simulation_res()$area)
    )
  })
}