Package index • antaresEditObject

All functions

activateRES(): Activate RES in an Antares study

activateST(): Activate st-storage in an Antares study

add_week_number_column_to_ts(): Add week number column to a data.time of time series type

adequacyOptions(): Adequacy patch parameters for creating an area

api_patch(): API methods

backupStudy(): Create a backup with an Antares Study

is_antares_v7() is_antares_v820(): Is study an Antares v7 study ?

checkRemovedArea(): Seek for a removed area

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

check_mingen_vs_maxpower(): Check if mingen data and maxpower data are consistent

cleanUpOutput(): Clean up output based on geographic trimming

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

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

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

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

copyOutput(): Copy of the output files of an Antares study

copyStudyWeb(): Import physical study to Antares Web (managed study)

createStudy() createStudyAPI(): Create an empty Antares study

createArea(): Create an area in an Antares study

createBindingConstraint(): Create a binding constraint

createBindingConstraintBulk() experimental: Create multiple binding constraint at once.

createCluster() createClusterRES(): Create a cluster

createClusterBulk(): Create serial thermal cluster

createClusterST(): Create a short-term storage cluster

createDSR() getCapacityDSR() editDSR(): Create a Demand Side Response (DSR)

createDistrict(): Create a district

createLink(): Create a link between two areas

createPSP() getCapacityPSP() editPSP(): Create a Pumped Storage Power plant (PSP)

create_scb_referential_series_type(): Create the correspondence data frame between the symbol and the type in scenario builder

deleteStudy(): Delete a study or a simulation

detect_pattern_in_binding_constraint(): Detect a pattern in a binding constraint coefficient

dicoAdequacySettings(): Correspondence between arguments of updateAdequacySettings and actual Antares parameters.

dicoGeneralSettings(): Correspondence between arguments of updateGeneralSettings and actual Antares parameters.

dicoOptimizationSettings(): Correspondence between arguments of updateOptimizationSettings and actual Antares parameters.

dicoOutputSettings(): Correspondence between arguments of updateOutputSettings and actual Antares parameters.

.api_command_execute_edit_area(): Edit area's parameters in API mode.

.api_command_execute_edit_area_ui(): Edit area's ui in API mode.

.format_ini_rhs(): Format a value to a suitable format to rhs in an .ini file.

.format_playlist_weights(): Generate playlist_year_weight section in the appropriate format.

.format_ui_data_by_mode(): Generate the data for the ui part by study mode.

.initializeLinksArea(): Initialize links data for a new area. For disk mode only.

.initializeRenewablesArea(): Initialize renewables data for a new area. For disk mode only.

.initializeThermalArea(): Initialize thermal data for a new area. For disk mode only.

.split_nodalOptimization_by_target(): Split list nodalOptimization by target file.

editArea(): Edit an area in an Antares study

editBindingConstraint(): Update an existing binding constraint

editCluster() editClusterRES(): Edit an existing cluster

editClusterST(): Edit a short-term storage cluster

editLink(): Edit a link between two areas

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

filteringOptions(): Output profile options for creating an area

getJobLogs(): Retrieve job log from API

getJobs(): Retrieve API jobs

get_default_hydro_ini_values(): Get default hydro.ini values

get_type_check_mingen_vs_hydrostorage(): Get the type of control to execute using the 3 necessary booleans

get_type_check_mingen_vs_hydrostorage_to_trigger(): Get the type of control to execute between mingen data and hydro storage data

get_type_check_mingen_vs_maxpower_to_trigger(): Get the type of control to execute between mingen data and maxpower data

importZipStudyWeb(): Import a local study to Antares Web

list_pollutants_values(): Output pollutants list for thermal clusters

mockSimulationAPI(): Mock API usage

nodalOptimizationOptions(): Nodal optimization parameters for creating an area

getPlaylist() setPlaylist(): Get the playlist of an Antares study

propertiesLinkOptions(): Properties for creating a link

removeArea(): Remove an area from an Antares study

removeBindingConstraint(): Remove a Binding Constraint

removeCluster() removeClusterRES() removeClusterST(): Remove a cluster

removeDistrict(): Remove a district

removeLink(): Remove a link between two areas

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

rollback_to_previous_data(): Rollback to previous hydro data if the data is not consistent

runSimulation(): Run an Antares Simulation

runTsGenerator(): Run Time-Series Generator

scenarioBuilder() readScenarioBuilder() updateScenarioBuilder() clearScenarioBuilder() deduplicateScenarioBuilder(): Read, create, update & deduplicate scenario builder

searchStudy(): Search study in AntaREST

setAPImode(): Set API mode

setSolverPath(): Set path to Antares Solver

setThematicTrimming(): Set the thematic trimming of an Antares Study

storage_values_default(): Short Term Storage Property List

updateAdequacySettings(): Update adequacy parameters of an Antares study

updateGeneralSettings(): Update general parameters of an Antares study

updateInputSettings(): Update input parameters of an Antares study

updateOptimizationSettings(): Update optimization parameters of an Antares study

updateOutputSettings(): Update output parameters of an Antares study

update_generaldata_by_section(): Update a specific section in generaldata.ini file

getVariantCommands() writeVariantCommands(): Get API commands generated

createVariant() useVariant(): Create a study's variant

writeIni() writeIniFile() writeIniAPI(): Write configuration options in file or API

writeEconomicOptions(): Write Economic Options

writeHydroValues(): Write Hydro Values

writeIniHydro(): Edit hydro.ini values

writeInputTS(): Write input time series

writeMiscGen(): Write Misc Gen data

writeOutputValues(): Write output value for Antares

writeSeriesPrepro(): Write prepro data

writeWaterValues(): Write water values