addProcessingH5: Add process results of antaresProcessing to an ANTARES .h5...

In antaresProcessing: 'Antares' Results Processing

Description

In this version only hourly data can be enriched.

Usage

addProcessingH5(
  opts = simOptions(),
  mcY = c("mcInd", "mcAll"),
  timeStep = "hourly",
  addNetLoad = FALSE,
  addDownwardMargin = FALSE,
  addUpwardMargin = FALSE,
  addExportAndImport = FALSE,
  addLoadFactorLink = FALSE,
  externalDependency = FALSE,
  loadFactor = FALSE,
  modulation = FALSE,
  netLoadRamp = FALSE,
  surplus = FALSE,
  surplusClusters = FALSE,
  thermalAvailabilities = FALSE,
  linkCapacity = FALSE,
  mustRun = FALSE,
  allProcess = FALSE,
  evalAreas = list(),
  evalLinks = list(),
  evalClusters = list(),
  evalDistricts = list(),
  nThreads = 1
)

Arguments

opts	simOptions obtain which setSimulationPath
mcY	character, "mcInd" or "mcAll".
timeStep	character, timeStep
addNetLoad	boolean refer to addNetLoad
addDownwardMargin	boolean refer to addDownwardMargin
addUpwardMargin	boolean refer to addUpwardMargin
addExportAndImport	boolean refer to addExportAndImport
addLoadFactorLink	boolean refer to addLoadFactorLink
externalDependency	boolean refer to externalDependency
loadFactor	boolean refer to loadFactor
modulation	boolean refer to modulation
netLoadRamp	boolean refer to netLoadRamp
surplus	boolean refer to surplus
surplusClusters	boolean refer to surplusClusters
thermalAvailabilities	boolean Should the surplus of the last unit of a cluster be computed by surplusClusters. Should loadFactorAvailable be added to the result of loadFactor.
linkCapacity	boolean should export and import capacities be computed by addExportAndImport.
mustRun	boolean should the production in must run mode subtracted to the net load addNetLoad. Should the must run production be ignored in the computation of the netLoadRamp see netLoadRamp.
allProcess	boolean All process in one argument.
evalAreas	list, list of operation to evaluate in areas data
evalLinks	list, list of operation to evaluate in links data
evalClusters	list, list of operation to evaluate in clusters data
evalDistricts	list, list of operation to evaluate in districts data
nThreads	numeric, nThreads to use

Details

When you add a straitment, an alias is created. They can be used for request h5 file. See examples.

Available alias are :

• "Out_addDownwardMargin"

• "Out_addUpwardMargin"

• "Out_addExportAndImport"

• "Out_addLoadFactorLink"

• "Out_externalDependency"

• "Out_loadFactor"

• "Out_modulation"

• "Out_netLoadRamp"

• "Out_surplus"

• "Out_surplusClusters"

Examples

## Not run: 
addProcessingH5(opts = opts,  mcY = "mcInd",
               addDownwardMargin = TRUE,
               addUpwardMargin = TRUE,
               addExportAndImport = TRUE,
               addLoadFactorLink = TRUE,
               externalDependency = TRUE,
               loadFactor = TRUE,
               modulation = TRUE,
               netLoadRamp = TRUE,
               surplus = TRUE,
               surplusClusters = TRUE,
               evalAreas = list(Tota = "`H. STOR` + `MISC. DTG`",
                                Tota2 = "`NODU` + `NP COST` + 1"),
               evalLinks = list(),
               evalClusters = list(),
               evalDistricts = list()
               )

#After write of new columns, new aliases are avialable in antaresRead.You can use
#showAliases() to see them. Prifix Out_ is used to distinguish them.
showAliases("Out_surplusClusters")
readAntares(opts = opts, select = "Out_surplusClusters")


## End(Not run)

antaresProcessing documentation built on Nov. 7, 2021, 1:06 a.m.