Learn R Programming

⚠️There's a newer version (0.9.0) of this package.Take me there.

antaresEditObject

Edit an Antares study before running a simulation.

Installation

Install from CRAN:

install.packages("antaresEditObject")

Or install dev version from GitHub:

remotes::install_github("rte-antares-rpackage/antaresEditObject", build_vignettes = TRUE)

Goal

This package allows to edit an Antares study. Methods are provided to create (and remove) areas, links between them, thermal clusters and binding constraints. These steps may be useful before running an Antares simulation.

See website for more documentation: https://rte-antares-rpackage.github.io/antaresEditObject/

Usage

Usage of the package is detailed in the vignette: vignette("antaresEditObject").

Copy Link

Version

Install

install.packages('antaresEditObject')

Monthly Downloads

561

Version

0.7.0

License

GPL (>= 2) | file LICENSE

Issues

Pull Requests

Stars

Forks

Repository

https://github.com/rte-antares-rpackage/antaresEditObject

Homepage

https://rte-antares-rpackage.github.io/antaresEditObject/

Maintainer

Tatiana Vargas

Last Published

May 30th, 2024

Functions in antaresEditObject (0.7.0)

Create an empty Antares study

Create a cluster

computeOtherFromHourlyYear

Compute daily, weekly, monthly and annual mc-ind from hourly data for one year. (new)

createClusterBulk

Create serial thermal cluster

dicoOptimizationSettings

Correspondence between arguments of updateOptimizationSettings and actual Antares parameters.

dicoGeneralSettings

Correspondence between arguments of updateGeneralSettings and actual Antares parameters.

Create a district

Create a link between two areas

Create a Pumped Storage Power plant (PSP)

.initializeRenewablesArea

Initialize renewables data for a new area. For disk mode only.

create_scb_referential_series_type

Create the correspondence data frame between the symbol and the type in scenario builder

.initializeThermalArea

Initialize thermal data for a new area. For disk mode only.

.api_command_execute_edit_area

Edit area's parameters in API mode.

createClusterST

Create a short-term storage cluster

Computation function for rebuild mc-ind daily, monthly and annual from hourly data.

computeTimeStampFromHourly

Compute daily, weekly, monthly and annual mc-ind from hourly data.

.initializeLinksArea

Initialize links data for a new area. For disk mode only.

Create a Demand Side Response (DSR)

Edit an existing cluster

editBindingConstraint

Update an existing binding constraint

Computation function for rebuild mc-ind weekly from daily data.

Retrieve job log from API

filteringOptions

Output profile options for creating an area

fill_empty_hydro_ini_file

Write default values in hydro.ini file if the section is empty

fill_empty_hydro_ts_file

Write default input time series if mingen.txt or/and mod.txt is empty

Edit a short-term storage cluster

Edit a link between two areas

nodalOptimizationOptions

Nodal optimization parameters for creating an area

Get the playlist of an Antares study Antares API OK

Antares API OK

importZipStudyWeb

Import a local study to Antares Web

Retrieve API jobs

createBindingConstraint

Create a binding constraint

mockSimulationAPI

Delete a study or a simulation

Create an area in an Antares study

list_pollutants_values

Output pollutants list for thermal clusters

propertiesLinkOptions

Properties for creating a link

Run Time-Series Generator

replicate_missing_ts

Replicate a data.table as many times as needed to get the same number of time series between 2 data.tables

Run an Antares Simulation

get_default_hydro_ini_values

Get default hydro.ini values

rollback_to_previous_data

Rollback to previous hydro data if the data is not consistent

removeBindingConstraint

Remove a Binding Constraint

detect_pattern_in_binding_constraint

Detect a pattern in a binding constraint coefficient

Remove an area from an Antares study

.split_nodalOptimization_by_target

Split list nodalOptimization by target file.

get_type_check_mingen_vs_maxpower_to_trigger

Get the type of control to execute between mingen data and maxpower data

scenario-builder

Read, create, update & deduplicate scenario builder

updateInputSettings

Update input parameters of an Antares study

updateGeneralSettings

Update general parameters of an Antares study

writeSeriesPrepro

Write prepro data

writeOutputValues

Write output value for Antares

Search study in AntaREST

Remove a cluster

Write configuration options in file or API

writeEconomicOptions

Write Economic Options

Edit an area in an Antares study

get_type_check_mingen_vs_hydrostorage_to_trigger

Get the type of control to execute between mingen data and hydro storage data

variant-commands

Get API commands generated

Remove a link between two areas

updateOutputSettings

Update output parameters of an Antares study

get_type_check_mingen_vs_hydrostorage

Get the type of control to execute using the 3 necessary booleans

updateOptimizationSettings

Update optimization parameters of an Antares study

Set path to Antares Solver

group_values_check

Check dimension of time series for binding constraints

writeHydroValues

Write Hydro Values

Write input time series

Create a study's variant

storage_values_default

Short Term Storage Property List

Write Misc Gen data

updateAdequacySettings

Update adequacy parameters of an Antares study

Edit hydro.ini values

writeWaterValues

Write water values

add_week_number_column_to_ts

Add week number column to a data.time of time series type

antaresRead-reexports

Re-exports from antaresRead

Activate RES in an Antares study

Activate st-storage in an Antares study

Create a backup with an Antares Study

adequacyOptions

Adequacy patch parameters for creating an area

checkRemovedArea

Seek for a removed area

check_consistency_reservoir_values

For a given area, check consistency between reservoir and reservoir capacity values

antaresEditObject-package

antaresEditObject: Edit an 'Antares' Simulation

Import physical study to Antares Web (managed study)

convertConfigToAdq

Read adequacy patch config.yml into Antares (v8.5+)

Is study an Antares v7 study ?

Copy of the output files of an Antares study

Clean up output based on geographic trimming

computeOtherFromHourlyMulti

Compute daily, weekly, monthly and annual mc-ind from hourly data multiyear. (new)

check_mingen_vs_maxpower

Check if mingen data and maxpower data are consistent

check_mingen_vs_hydro_storage

Check if mingen data and hydro storage data are consistent