antaresRead (version 2.0.1)

writeAntaresH5: Convert antares output to h5 file

Description

Convert antares output to h5 file

Usage

writeAntaresH5(path = getwd(), timeSteps = c("hourly", "daily", "weekly",
  "monthly", "annual"), opts = simOptions(), writeMcAll = TRUE,
  compress = 1, misc = FALSE, thermalAvailabilities = FALSE,
  hydroStorage = FALSE, hydroStorageMaxPower = FALSE, reserve = FALSE,
  linkCapacity = FALSE, mustRun = FALSE, thermalModulation = FALSE,
  allData = FALSE, writeAllSimulations = FALSE, nbCores = 4,
  removeVirtualAreas = FALSE, storageFlexibility = NULL,
  production = NULL, reassignCosts = FALSE, newCols = TRUE,
  overwrite = FALSE, supressMessages = FALSE)

Arguments

path

character folder where h5 file will be write (default getwd())

timeSteps

character timeSteps

opts

list of simulation parameters returned by the function setSimulationPath. Defaut to antaresRead::simOptions()

writeMcAll

boolean write mc-all

compress

numeric compress level

misc

boolean see readAntares

thermalAvailabilities

boolean see readAntares

hydroStorage

boolean see readAntares

hydroStorageMaxPower

boolean see readAntares

reserve

boolean see readAntares

linkCapacity

boolean see readAntares

mustRun

boolean see readAntares

thermalModulation

boolean see readAntares

allData

boolean add all data with a single call (writeMcAll, misc, thermalAvailabilities, hydroStorage, hydroStorageMaxPower reserve, linkCapacity, mustRun, thermalModulation).

writeAllSimulations

boolean, write all simulations of your antares study.

nbCores

numeric, number of cores to use, only used if writeAllSimulations is TRUE

removeVirtualAreas

boolean, remove virtual areas, see removeVirtualAreas

storageFlexibility

character, see removeVirtualAreas

production

character, see removeVirtualAreas

reassignCosts

boolean, see removeVirtualAreas

newCols

boolean, see removeVirtualAreas

overwrite

boolean, overwrite old file

supressMessages

boolean, supress messages from readAntares and removeVirtualAreas

Examples

# NOT RUN {
# }
# NOT RUN {
# Write simulation one by one
setSimulationPath("C:/Users/MyUser/Mystudy", 1)
writeAntaresH5()

# Write all simulations
setSimulationPath("C:/Users/MyUser/Mystudy")
writeAntaresH5(writeAllSimulations = TRUE)

# Choose timestep to write
setSimulationPath("C:/Users/MyUser/Mystudy", 1)
writeAntaresH5(timeSteps = "hourly")

# Write with additionnal information
writeAntaresH5(timeSteps = "hourly",
   misc = TRUE, thermalAvailabilities = TRUE,
   hydroStorage = TRUE, hydroStorageMaxPower = TRUE, reserve = TRUE,
   linkCapacity = TRUE, mustRun = TRUE, thermalModulation = TRUE)

# Write all data with a shorcut 
writeAntaresH5(allData = TRUE)

# }