Learn R Programming

⚠️There's a newer version (1.0.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

428

Version

0.6.1

License

GPL (>= 2) | file LICENSE

Issues

Pull Requests

Stars

Forks

Repository

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

Maintainer

Tatiana Vargas

Last Published

December 12th, 2023

Functions in antaresEditObject (0.6.1)

computeOtherFromHourlyYear

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

computeOtherFromHourlyMulti

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

Create a Pumped Storage Power plant (PSP)

Create a link between two areas

createClusterST

Create a short-term storage cluster

convertConfigToAdq

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

fill_empty_hydro_ts_file

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

createClusterBulk

Create serial thermal cluster

dicoGeneralSettings

Correspondence between arguments of updateGeneralSettings and actual Antares parameters.

dicoOptimizationSettings

Correspondence between arguments of updateOptimizationSettings and actual Antares parameters.

filteringOptions

Output profile options for creating an area

editBindingConstraint

Update an existing binding constraint

Remove a cluster

removeBindingConstraint

Remove a Binding Constraint

Create a Demand Side Response (DSR)

Edit a link between two areas

fill_empty_hydro_ini_file

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

updateInputSettings

Update input parameters of an Antares study

Create an area in an Antares study

Edit an area in an Antares study

Edit an existing cluster

get_type_check_mingen_vs_hydrostorage_to_trigger

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

Create a cluster

get_type_check_mingen_vs_maxpower_to_trigger

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

Search study in AntaREST

create_referential_series_type

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

rollback_to_previous_data

Rollback to previous hydro data if the data is not consistent

Run an Antares Simulation

Create a district

list_pollutants_values

Output pollutants list for thermal clusters

writeSeriesPrepro

Write prepro data

writeOutputValues

Write output value for Antares

updateOptimizationSettings

Update optimization parameters of an Antares study

Write Misc Gen data

Retrieve job log from API

Retrieve API jobs

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

writeWaterValues

Write water values

Get the playlist of an Antares study Antares API OK

Antares API OK

Run Time-Series Generator

nodalOptimizationOptions

Nodal optimization parameters for creating an area

mockSimulationAPI

propertiesLinkOptions

Properties for creating a link

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

updateGeneralSettings

Update general parameters of an Antares study

updateAdequacySettings

Update adequacy parameters of an Antares study

Remove an area from an Antares study

Set path to Antares Solver

Edit a short-term storage cluster

storage_values_default

Output pollutants list for thermal clusters

Edit hydro.ini values

Write input time series

Write configuration options in file or API

Create a study's variant

updateOutputSettings

Update output parameters of an Antares study

scenario-builder

Read, create, update & deduplicate scenario builder

variant-commands

Get API commands generated

get_type_check_mingen_vs_hydrostorage

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

get_default_hydro_ini_values

Get default hydro.ini values

replicate_missing_ts

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

writeHydroValues

Write Hydro Values

writeEconomicOptions

Write Economic Options

Remove a link between two areas

check_consistency_reservoir_values

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

check_mingen_vs_hydro_storage

Check if mingen data and hydro storage data are consistent

checkRemovedArea

Seek for a removed area

Is study an Antares v7 study ?

Activate RES in an Antares study

create-binding-constraint

Create a binding constraint

computeTimeStampFromHourly

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

Activate st-storage in an Antares study

Create an empty Antares study

check_mingen_vs_maxpower

Check if mingen data and maxpower data are consistent

antaresRead-reexports

Re-exports from antaresRead

Create a backup with an Antares Study

Clean up output based on geographic trimming

add_week_number_column_to_ts

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

Copy of the output files of an Antares study

adequacyOptions

Adequacy patch parameters for creating an area

Import physical study to Antares Web (managed study)