R/runSimulation.R

In antaresEditObject: Edit an 'Antares' Simulation

#' @title Run an Antares Simulation
#' 
#' @description 
#' `r antaresEditObject:::badge_api_ok()`
#' 
#' Run an ANTARES study
#' 
#' 
#' @param name
#'   Name of the simulation. In API mode, `name` will be used as `output_suffix` argument.
#' @param mode
#'   Simulation mode, can take value "economy", "adequacy" or "draft".
#' @param path_solver
#'   Character containing the Antares Solver path
#' @param show_output_on_console
#'   Logical, indicating whether to capture the ANTARES log and show 
#'   it on the R console.
#' @param wait
#'   Logical, indicating whether the R interpreter should wait for the 
#'   simulation to finish, or run it asynchronously. 
#' @param parallel
#'   Logical. If `TRUE` the ANTARES simulation will be run in parallel mode (Work
#'   only with ANTARES v6.0.0 or more). In that case, the number of cores used by the simulation
#'   is the one set in advanced_settings/simulation_cores (see ANTARES interface).
#' @param ... Additional arguments (API only), such as `nb_cpu`, `time_limit`, ...
#'  See API documentation for all available options.
#' @param opts
#'   List of simulation parameters returned by the function
#'   [antaresRead::setSimulationPath()]
#' 
#' @return 
#' In API mode it return a `list` with either the job id in case of success of
#'  the command or details about the error produce.
#' In non-API mode the function does not return anything, it is  used to launch an 
#' ANTARES simulation.
#' 
#' @importFrom assertthat assert_that
#' @importFrom antaresRead simOptions api_post
#' @export
#' 
### Taken from antaresXpansion_0.5.2 ###
runSimulation <- function(name, 
                          mode = "economy", 
                          path_solver = getOption("antares.solver"), 
                          wait = TRUE, 
                          show_output_on_console = FALSE, 
                          parallel = TRUE, 
                          ...,
                          opts = antaresRead::simOptions()) {
  assertthat::assert_that(inherits(opts, "simOptions"))
  
  if (is_api_study(opts)) {
    updateGeneralSettings(mode = mode, opts = opts)
    run <- api_post(
      opts = opts, 
      endpoint = paste0("launcher/run/", opts$study_id), 
      default_endpoint = "v1",
      body = jsonlite::toJSON(list(output_suffix = name, ...), auto_unbox = TRUE),
      encode = "raw"
    )
    if (is.null(run$job_id)) {
      cli::cli_alert_danger("No job id returned by API, something went wrong.")
      return(run)
    } else {
      cli::cli_alert_success(paste("Job launched with ID:", run$job_id))
    }
    if (!isTRUE(wait)) {
      return(run)
    } else {
      status <- getJobs(run$job_id, opts = opts)
      while (is.null(status$completion_date) || is.na(status$completion_date)) {
        Sys.sleep(1)
        status <- getJobs(run$job_id, opts = opts)
      }
      if (isTRUE(show_output_on_console)) {
        # getJobLogs(job_id = run$job_id, opts = opts)
        cli::cli_alert_info(paste0(
          "Retrieve job logs with: {.code getJobLogs(\"", run$job_id, "\")}"
        ))
      }
      return(status)
     }
  } else {
    if (is.null(path_solver)) {
      path_solver <- setSolverPath()
    }
    # a few checks
    name <- tolower(name)
    assertthat::assert_that(file.exists(path_solver))
    assertthat::assert_that(mode %in% c("economy", "adequacy", "draft", "expansion"))
    
    
    ##Test version of antares solver
    solver <- unlist(gsub("-solver.exe", "", path_solver))
    solver <- strsplit(solver, "antares-")[[1]]
    solver <- solver[[length(solver)]]
    version_solver <- substr(solver, 1, 1)
    version_study <- substr(opts$antaresVersion,1,1)
    
    if (version_solver != version_study) {
      stop(paste0(
        "Imcompatibility between antares solver version (", version_solver, ") and study version (", version_study, ")"
      ), call. = FALSE)
    }
    
    
    #Launch simulation
    if (version_solver >= 6 & parallel) {
      cmd <- '"%s" "%s" -n "%s" --%s --parallel'
      cmd <- sprintf(cmd, path_solver, opts$studyPath, name, mode)
    } else {
      cmd <- '"%s" "%s" -n "%s" --%s'
      cmd <- sprintf(cmd, path_solver, opts$studyPath, name, mode)
    }
    
    system(cmd, ignore.stdout = TRUE, wait = wait, show.output.on.console = show_output_on_console)
  }
}