setup-wm: Setup a WM simulation before running Antares

Description Usage Arguments Value Examples

Description

Setup a WM simulation before running Antares

Set path to inputs for WM simulation

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
sim_wm(date_prev, start_prev_hebdo, path_inputs = path_sim_wm(),
  n_mcyears = 2040, type_load = "prevu", load_offset_options = NULL,
  dispo_pump = c(3520, 3520, 3520, 3520, 3520, 3520, 3520),
  simulation_source = NULL, simulation_dest = NULL,
  copy_study = TRUE, flow_based = FALSE, opts = NULL)

path_sim_wm(path_dir = "inputs", meteologica = "meteologica",
  cnes = "cnes", planning = "planning", forfait_oa = "forfait_oa",
  ntc = "ntc", ntc_tp = "ntc_tp", capa_hydro = "capa_hydro",
  hydro = "hydro", eco2mix = "eco2mix")

force_path(...)

Arguments

date_prev

Date of simulation.

start_prev_hebdo

Date of forecasts, with format %Y-%m-%d.

path_inputs

A list with path to inputs directories, obtained with path_sim_wm.

n_mcyears

Number of MC years in the study, default to 2040.

type_load

Forecast to use "prevu", "premis" or "offset".

load_offset_options

DEPRECATED. Peak and off-peak if type_load = "offset", see offset_opts.

dispo_pump

Pumpage availability.

simulation_source

Path to source simulation for creating Hydro for other areas. If provided a copy of this simulation will be performed.

simulation_dest

Name of the directory where to copy the study. Warning: content of directory will be deleted!

copy_study

Make a copy of the whole study before modifying Antares inputs.

flow_based

Logical, is this a flow based study ? If TRUE, NTC steps are ignored.

opts

List of simulation parameters returned by the function antaresRead::setSimulationPath

path_dir

Main directory where inputs are.

meteologica

Sub-directory containing meteologica files.

cnes

Sub-directory containing CNES files.

planning

Sub-directory containing planning files.

forfait_oa

Sub-directory containing forfait OA files.

ntc

Sub-directory containing NTC files.

ntc_tp

Sub-directory containing NTC transparency files.

capa_hydro

Sub-directory containing Hydraulic capacity transparency files.

hydro

Sub-directory containing hydro files.

eco2mix

Sub-directory containing eco2mix files.

...

Character vectors indicating path to a directory, use this to specify a path outside the "path_dir" directory.

Value

For path_sim_wm a named list.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
## Not run: 

library(antaresRead)
library(antaresWeeklyMargin)

opts <- setSimulationPath("path/to/original/study")

sim_wm(
  date_prev = "2018-06-21",
  start_prev_hebdo = "2018-06-23", 
  simulation_dest = "test_case_WM",
  type_load = "prevu",
  path_inputs = path_sim_wm(  # Path to input data
    path_dir = "../inputs", 
    meteologica = "meteologica", 
    cnes = "cnes",           
    planning = "planning", 
    forfait_oa = "forfait_oa",  
    ntc = "ntc",         
    ntc_tp = "ntc_tp",    
    capa_hydro = "capa_hydro",  
    hydro = "hydro"   
  ), 
  opts = opts
)


## End(Not run)

rte-antares-rpackage/antaresWeeklyMargin documentation built on May 16, 2019, 8:15 p.m.