read_storages_constraints: Read Short-term storages / additional constraints

View source: R/read_st_constraints.R

read_storages_constraintsR Documentation

Read Short-term storages / additional constraints

Description

Antares API OK [Experimental]

This function reads constraints of an Antares project (by area/cluster) :

  • Properties

  • Time series

Be aware that constraints are read in the input files of a study. So they may have changed since a simulation has been run.

Usage

read_storages_constraints(opts = simOptions())

Arguments

opts

list of simulation parameters returned by the function setSimulationPath

Value

list with 2 sections per cluster/constraint (properties + values).

Examples

## Not run: 
# read/load an existing study (version >= 9.2)
setSimulationPath(path = "mypath/study")

read_storages_constraints()

## End(Not run)

antaresRead documentation built on Nov. 5, 2025, 7:42 p.m.