Package: antaresEditObject 0.9.0

Tatiana Vargas

antaresEditObject: Edit an 'Antares' Simulation

Edit an 'Antares' simulation before running it : create new areas, links, thermal clusters or binding constraints or edit existing ones. Update 'Antares' general & optimization settings. 'Antares' is an open source power system generator, more information available here : <https://antares-simulator.org/>.

Authors:Tatiana Vargas [aut, cre], Frederic Breant [ctb], Victor Perrier [ctb], Baptiste Seguinot [ctb], Benoit Thieurmel [ctb], Titouan Robert [ctb], Jalal-Edine Zawam [ctb], Etienne Sanchez [ctb], Janus De Bondt [ctb], Assil Mansouri [ctb], Abdallah Mahoudi [ctb], Clement Berthet [ctb], Kamel Kemiha [ctb], Nicolas Boitard [ctb], RTE [cph]

antaresEditObject_0.9.0.tar.gz
antaresEditObject_0.9.0.zip(r-4.5)antaresEditObject_0.9.0.zip(r-4.4)antaresEditObject_0.9.0.zip(r-4.3)
antaresEditObject_0.9.0.tgz(r-4.5-any)antaresEditObject_0.9.0.tgz(r-4.4-any)antaresEditObject_0.9.0.tgz(r-4.3-any)
antaresEditObject_0.9.0.tar.gz(r-4.5-noble)antaresEditObject_0.9.0.tar.gz(r-4.4-noble)
antaresEditObject_0.9.0.tgz(r-4.4-emscripten)antaresEditObject_0.9.0.tgz(r-4.3-emscripten)
antaresEditObject.pdf |antaresEditObject.html✨
antaresEditObject/json (API)
NEWS

# Install 'antaresEditObject' in R:
install.packages('antaresEditObject', repos = c('https://rte-antares-rpackage.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/rte-antares-rpackage/antareseditobject/issues

Pkgdown site:https://rte-antares-rpackage.github.io

On CRAN:

Conda:

antares-simulationclusterenergymonte-carlo-simulationrte

8.76 score 8 stars 101 scripts 676 downloads 91 exports 64 dependencies

Last updated 22 days agofrom:2fa95e48ad. Checks:8 OK. Indexed: yes.

TargetResultLatest binary
Doc / VignettesOKFeb 17 2025
R-4.5-winOKFeb 17 2025
R-4.5-macOKFeb 17 2025
R-4.5-linuxOKFeb 17 2025
R-4.4-winOKFeb 17 2025
R-4.4-macOKFeb 17 2025
R-4.3-winOKFeb 17 2025
R-4.3-macOKFeb 17 2025

Exports:activateRESactivateSTadequacyOptionsapi_patchbackupStudycheckRemovedAreacleanUpOutputclearScenarioBuildercomputeOtherFromHourlyMulticomputeOtherFromHourlyYearcomputeTimeStampFromHourlyconvertConfigToAdqcopyOutputcopyStudyWebcreate_scb_referential_series_typecreateAreacreateBindingConstraintcreateBindingConstraintBulkcreateClustercreateClusterBulkcreateClusterREScreateClusterSTcreateDistrictcreateDSRcreateLinkcreatePSPcreateStudycreateStudyAPIcreateVariantdeduplicateScenarioBuilderdeleteStudydicoGeneralSettingsdicoOptimizationSettingsdicoOutputSettingseditAreaeditBindingConstrainteditClustereditClusterRESeditClusterSTeditDSReditLinkeditPSPfilteringOptionsgetCapacityDSRgetCapacityPSPgetJobLogsgetJobsgetPlaylistgetVariantCommandsgroup_values_meta_checkimportZipStudyWebis_antares_v7is_antares_v820list_pollutants_valuesmockSimulationAPInodalOptimizationOptionspropertiesLinkOptionsreadScenarioBuilderremoveArearemoveBindingConstraintremoveClusterremoveClusterRESremoveClusterSTremoveLinkrunSimulationrunTsGeneratorscenarioBuildersearchStudysetAPImodesetPlaylistsetSolverPathstorage_values_defaultupdateAdequacySettingsupdateGeneralSettingsupdateInputSettingsupdateOptimizationSettingsupdateOutputSettingsupdateScenarioBuilderuseVariantwriteEconomicOptionswriteHydroValueswriteIniwriteIniAPIwriteIniFilewriteIniHydrowriteInputTSwriteMiscGenwriteOutputValueswriteSeriesPreprowriteVariantCommandswriteWaterValues

Dependencies:antaresReadaskpassassertthatbase64encbitbit64bslibcachemclicodetoolscommonmarkcpp11crayoncurldata.tabledigestdoFuturedoParallelfastmapfontawesomeforeachfsfuturefuture.applygenericsglobalsgluehtmltoolshttpuvhttriteratorsjquerylibjsonlitelaterlifecyclelistenvlubridatemagrittrmemoisememusemimeopensslparallellypbapplyplyrprogressrpromisespurrrR6rappdirsRcpprlangsassshinysourcetoolsstringistringrsystimechangevctrswhiskerwithrxtableyaml

Antares new features v8.6.0

Rendered fromAntares_new_features_v860.Rmdusingknitr::rmarkdownon Feb 17 2025.

Last update: 2024-10-03
Started: 2023-09-15

Renewables Energy Sources

Rendered fromrenewables-energy-sources.Rmdusingknitr::rmarkdownon Feb 17 2025.

Last update: 2023-10-03
Started: 2021-10-19

Scenario Builder

Rendered fromscenario-builder.Rmdusingknitr::rmarkdownon Feb 17 2025.

Last update: 2023-10-03
Started: 2021-10-19

User guide

Rendered fromantaresEditObject.Rmdusingknitr::rmarkdownon Feb 17 2025.

Last update: 2024-10-03
Started: 2019-12-11

Variant management with API

Rendered fromapi-variant-management.Rmdusingknitr::rmarkdownon Feb 17 2025.

Last update: 2025-02-17
Started: 2022-02-07

Readme and manuals

Help Manual

Help pageTopics
Edit area's parameters in API mode..api_command_execute_edit_area
Format a value to a suitable format to rhs in an .ini file..format_ini_rhs
Generate playlist_year_weight section in the appropriate format..format_playlist_weights
Initialize links data for a new area. For disk mode only..initializeLinksArea
Initialize renewables data for a new area. For disk mode only..initializeRenewablesArea
Initialize thermal data for a new area. For disk mode only..initializeThermalArea
Split list nodalOptimization by target file..split_nodalOptimization_by_target
Activate RES in an Antares studyactivateRES
Activate st-storage in an Antares studyactivateST
Add week number column to a data.time of time series typeadd_week_number_column_to_ts
Adequacy patch parameters for creating an areaadequacyOptions
API methodsapi_patch
Create a backup with an Antares StudybackupStudy
For a given area, check consistency between reservoir and reservoir capacity valuescheck_consistency_reservoir_values
Check if mingen data and hydro storage data are consistentcheck_mingen_vs_hydro_storage
Check if mingen data and maxpower data are consistentcheck_mingen_vs_maxpower
Is study an Antares v7 study ?check-version is_antares_v7 is_antares_v820
Seek for a removed areacheckRemovedArea
Clean up output based on geographic trimmingcleanUpOutput
Compute daily, weekly, monthly and annual mc-ind from hourly data multiyear. (new)computeOtherFromHourlyMulti
Compute daily, weekly, monthly and annual mc-ind from hourly data for one year. (new)computeOtherFromHourlyYear
Compute daily, weekly, monthly and annual mc-ind from hourly data.computeTimeStampFromHourly
Read adequacy patch config.yml into Antares (v8.5+)convertConfigToAdq
Copy of the output files of an Antares studycopyOutput
Import physical study to Antares Web (managed study)copyStudyWeb
Create the correspondence data frame between the symbol and the type in scenario buildercreate_scb_referential_series_type
Create an empty Antares studycreate-study createStudy createStudyAPI
Create an area in an Antares studycreateArea
Create a binding constraintcreateBindingConstraint
Create multiple binding constraint at once.createBindingConstraintBulk
Create a clustercreateCluster createClusterRES
Create serial thermal clustercreateClusterBulk
Create a short-term storage clustercreateClusterST
Create a districtcreateDistrict
Create a Demand Side Response (DSR)createDSR editDSR getCapacityDSR
Create a link between two areascreateLink
Create a Pumped Storage Power plant (PSP)createPSP editPSP getCapacityPSP
Delete a study or a simulationdeleteStudy
Detect a pattern in a binding constraint coefficientdetect_pattern_in_binding_constraint
Correspondence between arguments of 'updateAdequacySettings' and actual Antares parameters.dicoAdequacySettings
Correspondence between arguments of 'updateGeneralSettings' and actual Antares parameters.dicoGeneralSettings
Correspondence between arguments of 'updateOptimizationSettings' and actual Antares parameters.dicoOptimizationSettings
Correspondence between arguments of 'updateOutputSettings' and actual Antares parameters.dicoOutputSettings
Edit an area in an Antares studyeditArea
Update an existing binding constrainteditBindingConstraint
Edit an existing clustereditCluster editClusterRES
Edit a short-term storage clustereditClusterST
Edit a link between two areaseditLink
Write default values in hydro.ini file if the section is emptyfill_empty_hydro_ini_file
Write default input time series if 'mingen.txt' or/and 'mod.txt' is emptyfill_empty_hydro_ts_file
Output profile options for creating an areafilteringOptions
Get default hydro.ini valuesget_default_hydro_ini_values
Get the type of control to execute using the 3 necessary booleansget_type_check_mingen_vs_hydrostorage
Get the type of control to execute between mingen data and hydro storage dataget_type_check_mingen_vs_hydrostorage_to_trigger
Get the type of control to execute between mingen data and maxpower dataget_type_check_mingen_vs_maxpower_to_trigger
Retrieve job log from APIgetJobLogs
Retrieve API jobsgetJobs
Import a local study to Antares WebimportZipStudyWeb
Output pollutants list for thermal clusterslist_pollutants_values
Mock API usagemockSimulationAPI
Nodal optimization parameters for creating an areanodalOptimizationOptions
Get the playlist of an Antares studygetPlaylist playlist setPlaylist
Properties for creating a linkpropertiesLinkOptions
Remove an area from an Antares studyremoveArea
Remove a Binding ConstraintremoveBindingConstraint
Remove a clusterremoveCluster removeClusterRES removeClusterST
Remove a link between two areasremoveLink
Replicate a data.table as many times as needed to get the same number of time series between 2 data.tablesreplicate_missing_ts
Rollback to previous hydro data if the data is not consistentrollback_to_previous_data
Run an Antares SimulationrunSimulation
Run Time-Series GeneratorrunTsGenerator
Read, create, update & deduplicate scenario builderclearScenarioBuilder deduplicateScenarioBuilder readScenarioBuilder scenario-builder scenarioBuilder updateScenarioBuilder
Search study in AntaRESTsearchStudy
Set API modesetAPImode
Set path to Antares SolversetSolverPath
Short Term Storage Property Liststorage_values_default
Update a specific section in generaldata.ini fileupdate_generaldata_by_section
Update adequacy parameters of an Antares studyupdateAdequacySettings
Update general parameters of an Antares studyupdateGeneralSettings
Update input parameters of an Antares studyupdateInputSettings
Update optimization parameters of an Antares studyupdateOptimizationSettings
Update output parameters of an Antares studyupdateOutputSettings
Create a study's variantcreateVariant useVariant variant
Get API commands generatedgetVariantCommands variant-commands writeVariantCommands
Write configuration options in file or APIwrite-ini writeIni writeIniAPI writeIniFile
Write Economic OptionswriteEconomicOptions
Write Hydro ValueswriteHydroValues
Edit hydro.ini valueswriteIniHydro
Write input time serieswriteInputTS
Write Misc Gen datawriteMiscGen
Write output value for AntareswriteOutputValues
Write prepro datawriteSeriesPrepro
Write water valueswriteWaterValues