writeIniHydro {antaresEditObject} | R Documentation |
Edit hydro.ini values
Description
For a given area, write its data in the hydro.ini file.
Usage
writeIniHydro(area, params, mode = "other", opts = antaresRead::simOptions())
Arguments
area |
The area where to edit the values. |
params |
The list data must have specific names and specific types :
|
mode |
Execution mode. Useful when you create a new area or remove an existing area to avoid control on hydro data. |
opts |
List of simulation parameters returned by the function
|
Warning
For an Antares version >= 860, control of data consistency between mingen.txt
and mod.txt
can be executed.
For an Antares version >= 860, control of data consistency between mingen.txt
and maxpower_<area>.txt
can be executed.
These controls depend on the values you find in hydro.ini
file.
Examples
## Not run:
opts <- setSimulationPath(studypath, simulation = "input")
createArea("fictive_area")
writeIniHydro(area = "fictive_area"
, params = list("leeway low" = 2.5, "leeway up" = 25))
## End(Not run)