readBindingConstraints: Read binding constraints

In rte-antares-rpackage/antaresRead: Import, Manipulate and Explore the Results of an 'Antares' Simulation

Read binding constraints

Description

This function reads the binding constraints of an Antares project.

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

Usage

readBindingConstraints(opts = simOptions())

Arguments

opts	list of simulation parameters returned by the function setSimulationPath

Value

An object of class bindingConstraints. This object is also a named list with 3 sections per read constraint.

Warning

Since ⁠release 2.7.0⁠ the structure of the returned object has evolved for all versions of study Antares:

• .ini parameters are in section properties

• Coeffcients links or thermal are in section coefs

• Values are already in section values

Note

For an study Antares version >=8.7.0. Now contains data.frame with one line per time step and p colums according to "scenarized RHS".

For "both" case, you will find in section values two data.frame :

• One data.frame for less

• One data.frame for greater

For an study Antares version <8.7.0.

Section values contains one line per time step and three columns "less", "greater" and "equal"

Examples

## Not run: 
setSimulationPath()

constraints <- readBindingConstraints()

# read properties
constraints$properties

# read coefs
constraints$coefs

# read values
constraints$values
  # both case ( study Antares >=8.7.0)
constraints$values$less
constraints$values$greater

# display equation (only for study Antares <8.7.0)
summary(constraints)


## End(Not run)

rte-antares-rpackage/antaresRead documentation built on Oct. 18, 2024, 7:49 a.m.