adqH5: Run the adequacy patch and save the result in an h5 format...

Description Usage Arguments Examples

View source: R/adqPatchH5.R

Description

This function runs the adequacy patch (adqPatch) on an Antares output and saves the result in an h5 file.

Usage

1
2
adqH5(opts, fb_opts, strategic_reserve_be = NULL,
  strategic_reserve_de = NULL)

Arguments

opts

list of simulation parameters returned by the function setSimulationPath. By default, the value is given by antaresRead::simOptions(), it must refer to an h5 file.

fb_opts

list of simulation parameters returned by the function setSimulationPath or flow-based model path obtained with the function setFlowbasedPath. By default, the value is returned by antaresRead::simOptions().

strategic_reserve_be

character, name of the virtual area representing the strategic reserve of Belgium

strategic_reserve_de

character, name of the virtual area representing the strategic reserve of Germany

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
29
30
31
## Not run: 


##Opts defind on txt files
opts <- antaresRead::setSimulationPath("D:/Users/titorobe/Desktop/antaresStudy",2)

##Write h5 stud
antaresRead::writeAntaresH5()

##Do a setSimulationPath on h5 file
opts <- antaresRead::setSimulationPath("D:/Users/titorobe/Desktop/Antares/antaresFlowbased",1)

##Use for user folder, you cal also use setFlowbasedPath
fb_opts = antaresRead::setSimulationPath("D:/Users/titorobe/Desktop/antaresStudy", 2)

##Compute adq on H5 file
adqH5(opts, fb_opts)

##Set alias for an easy read
setAlias("adqPatch", "Alias for adqPatch", c("LOLD_ADQPatch",
                                             "UNSP. ENRG_ADQPatch", "DTG MRG_ADQPatch",
                                             "UNSP. ENRG_ADQPatch", "BALANCE_ADQPatch",
                                             "FLOW LIN._ADQPatch",
                                             "areas", "links"))

##Read with alias
readAntares(select = "adqPatch", opts = opts, mcYears = 1)



## End(Not run)

rte-antares-rpackage/antaresFlowbased documentation built on Oct. 19, 2020, 11:23 a.m.