Skip to contents

Changelog

Source: NEWS.md

antaresEditObject 0.9.2

CRAN release: 2025-09-24

(cf. Antares v9.2 changelog)

NEW FEATURES :

  • createStudy() initializes the study by updating the generaldata.ini file :
    • the value of the shedding-policy parameter is changed to “accurate shave peaks”
    • a new “compatibility” section is created with parameter hydro-pmax = “daily”
  • createArea() initializes the hydro.ini file with a new parameter overflow spilled cost difference (for each area)
  • createClusterST()/editClusterST() : Parameter group is now dynamic and have no restriction
  • createClusterST()/editClusterST() :
    • New properties (efficiencywithdrawal, penalize-variation-injection, penalize-variation-withdrawal, see list of properties according to study version of Antares with storage_values_default())
    • New optional time series (cost-injection, cost-withdrawal, cost-level, cost-variation-injection, cost-variation-withdrawal)
    • New additional constraints (properties and time series)
  • removeClusterST() : remove New optional time series + New additional constraints
  • updateScenarioBuilder() New type of series “hfl” (“hydro final level”, similar to “hydrolevels”) is available
  • removeDistrict() remove a district from a study
  • createArea()/editArea(): in API mode, allow the user to customize localization and color of an area

NEW FEATURES (other) :

  • editBindingConstraint() : control the dimensions of the matrix only if a time series is provided by the user for optimization
  • .createCluster() uses a specific endpoint to write cluster’s metadata and commands to write matrix
  • Add new function setThematicTrimming() to set the thematic trimming in file generaldata.ini

Breaking changes :

  • createClusterST() : For a study < v9.2, execution will be STOP if group is not included in list (see doc)
  • updateAdequacySettings() : Two parameters (enable-first-step, set-to-null-ntc-between-physical-out-for-first-step) are deprecated and removed. Parameters are forced to NULL with study >= v9.2.

BUGFIXES :

DOC :

A new article exposing new features of Antares Simulator v9.2 is available here

antaresEditObject 0.9.0

CRAN release: 2025-02-14

(cf. Antares v9 changelog)

NEW FEATURES (Antares v9.0) :

  • createStudy() takes into account the new format of Antares studies (e.g. 9.0, 9.15 instead of 900, 915)

BUGFIXES :

  • editBindingConstraint() :
    • operator parameter set to NULL, by default, no longer causes an error.
    • To add values, the operator parameter is now required.
    • For a study version >= 832, the filter-year-by-year and filter-synthesis properties are retained in the .ini file if they are not modified.
  • [private function] api_command_execute() manage snapshot generation of a variant study with a tempo to wait the end of current task (prevents the order from being ignored).
    • You can use global parameter verbose to TRUE (#274 antaresRead) to display diagnostic messages (getOption("antares"))
  • updateAdequacySettings() : in API mode do not send NULL value

GITHUB ACTIONS :

  • Actions artifacts v3 is closing down, update to v4
  • test-coverage.yaml updated

antaresEditObject 0.7.1

CRAN release: 2024-09-27

Breaking changes :

NEW FEATURES (Antares v8.8) :

BUGFIXES :

OTHER UPDATES :

DOC :

  • createClusterST() : update doc to discrabe st-storage list parameters + “Inflows” parameter

antaresEditObject 0.7.0

CRAN release: 2024-05-30

Scenarized RHS for binding constraints

NEW FEATURES (Antares v8.7, cf. Antares v8.7 changelog) :

Breaking changes :

antaresEditObject 0.6.4

CRAN release: 2024-05-24

BREAKING CHANGES :

  • Add UTF-8 encoding argument in .getJobs()
  • Unit tests no longer call the study in the antaresRead package for versions > 8.0.0

BUGFIXES :

  • createArea()/editArea() : in API mode, split data in nodalOptimization argument to write it in the expected files
  • editArea() : not delete one of the two economic options if only one must be edited
  • Avoid data deletion in API mode for editArea()

antaresEditObject 0.6.3

CRAN release: 2024-04-29

NEW FEATURES :

  • Complete function deleteStudy() with new parameter simulation to delete a simulation in an Antares study.
  • New parameter geographic.trimming in updateGeneralSettings()to activate or deactivate this general parameter.
  • Add importZipStudyWeb() to allow the user to import a local study in Antares Web

Breaking changes

  • setPlaylist() optimized for the API mode
  • .createCluster() uses data.table::fwrite() instead of utils::write.table() for optimization
  • createCluster() parameter list_pollutants default value to NULL.
  • createBindingConstraint() parameter coefficients must be alphabetically ordered.
  • .createCluster() default matrix in API mode.
  • removeArea() :
    • control the existence of an area in a binding constraint coefficient before deletion
    • no longer deletes a binding constraint
  • removeLink() : control the existence of a link a in a binding constraint coefficient before deletion
  • removeCluster() : control the existence of a cluster a in a binding constraint coefficient before deletion
  • createClusterST() : add a control to check if a cluster exists before running actions.
  • editClusterST() : add a control to check if a cluster exists before running actions.
  • .removeCluster() : add a control to check if a cluster exists before running actions in st-storage mode.
  • Update documentation for scenarioBuilder : user must enable/disable custom-scenario property in generaldata.ini by himself

BUGFIXES :

  • Fix filter_synthesis and filter_year_by_year parameters of editLink() in API mode
  • Fix setPlaylist() works in API and local mode with weights.
  • Fix getPlaylist() works in API and local mode with weights.
  • Fix createDSR() in API mode : daily binding constraint takes 366 rows.
  • Fix createCluster() and editCluster() parameter list_pollutants stop if Antares Version < 8.6.0
  • getJobs() no longer returns duplicates and displays the two new columns owner_id and owner_name.
  • Allow the user to set symbol or full name as argument series in updateScenarioBuilder()
  • scenarioBuilder() matrix has the same row repeated if the area is not rand
  • Fix createLink() to update opts in API mode.
  • Fix editClusterST() : can not edit a cluster if it does not exist in API mode.
  • updateScenarioBuilder() works for NTC part : allow cartesian in the merge.
  • api_command_execute() :
    • no longer deletes a command
    • displays a success message for a study or variant
  • removeCluster() no longer deletes everything in the folder prepro

antaresEditObject 0.6.2

CRAN release: 2024-04-19

  • Fix test to remove rev dep to antaresRead (see cran-comments.md for details)

antaresEditObject 0.6.1

CRAN release: 2023-12-12

  • writeInputTS() allows the user to set a link with the separator ’ - ’ (ex: ‘area1 - area2’)

BUGFIXES :

  • Error CRAN CHECKS (fix issue #115)

antaresEditObject 0.6.0

CRAN release: 2023-10-03

Breaking changes (Antares v8.6, cf. Antares v8.6 changelog) :

NEW FEATURES (Antares v8.6) :

  • New function activateST() Activate “st-storage” in an Antares study.
  • New functions createClusterST(), editClusterST(), removeClusterST() (“st-storage” family of functions for a study in “input” mode)
  • Add control of data consistency between mingen.txt and mod.txt based on values in hydro.ini file
  • Add control of data consistency between mingen.txt and maxpower.txt based on values in hydro.ini file
  • Add and edit the property enable-first-step in adequacy patch section in settings/generaldata.ini

NEW FEATURES :

Breaking changes

  • deleteStudy() no longer requires user confirmation
  • api_command_execute() displays an error message and causes the program to stop following an http error code. The error message is completed with the API error description
  • getPlaylist() is compatible with the new format returned by readIniAPI()
  • removeClusterRES() in API mode
  • removeLink() delete properly data for an Antares version >= 820
  • rollback_to_previous_data() enable to rollback if original value is NULL
  • writeInputTS() allows the user to set a link with the separator ’ - ’ (ex: ‘area1 - area2’)

BUGFIXES :

  • api_command_execute() add timer to request api
  • writeInputTS() works with argument type = "tsLink"
  • createLink() and editLink() write the appropriate time series in _direct.txt and _indirect.txt files even if the areas from and to given as arguments are not sorted

DOC :

  • A new article presenting v8.6 features is available on the package’s online documentation.

antaresEditObject 0.5.1

CRAN release: 2023-04-06

NEW FEATURES :

BUGFIXES :

antaresEditObject 0.5.0

CRAN release: 2023-03-10

NEW FEATURES :

BUGFIXES :

antaresEditObject 0.4.1

BUGFIXES :

antaresEditObject 0.4.0

CRAN release: 2022-12-06

New functions

  • Antares v840 : new parameter result-format to choose output format (txt/zip) + new values for transmission-capacities parameter.
  • Antares v832 : added filtering options to bindingConstraints.
  • Antares v830 : updateAdequacySettings() function to activate Adequacy Patch and set parameters. + createArea() and editArea() support for new adequacy_patch.ini file.
  • Antares v820 : createLink() and editLink() have a new argument tsLink allowing to write transmission capacities time-series.
  • createBindingConstraintBulk() allow to create multiple binding constraints at once.

Breaking changes

  • Argument’s order of writeInputTS() has changed, data is now in first place.

Variant management with API

This release include some new features to interact with Antares Web.

antaresEditObject 0.3.0

CRAN release: 2021-11-08

Breaking changes

Renewable Energy Sources

This release include some new features to interact with renewable energy sources (new in Antares v8.0.3):

Other updates

antaresEditObject 0.2.2

CRAN release: 2021-06-21

  • New usage getPlaylist : V8 antares ponderation.
  • New usage setPlaylist : V8 antares ponderation.

antaresEditObject 0.2.1

  • New function copyOutput : to copy antares output with extension.
  • New function writeOutputValues : to write antares data after antaresRead (areas, links and clusters).
  • New function computeTimeStampFromHourly : to write mc-ind data from hourly files (daily, weekly, monthly and annual).
  • New function parAggregateMCall : to compute mc-all from md-ind.
  • New function editArea : to edit an area.
  • New function editBindingConstraint : to edit a Binding Constraint.

antaresEditObject 0.2.0

antaresEditObject 0.1.9

CRAN release: 2020-02-20

Bugfixes

antaresEditObject 0.1.8

  • Internal release.

antaresEditObject 0.1.7

CRAN release: 2019-07-18

  • Fix createPSP to work with Antares v7

antaresEditObject 0.1.6

CRAN release: 2019-05-13

  • Compatibility with Antares version 7

antaresEditObject 0.1.4

  • Initial release.
  • Added a NEWS.md file to track changes to the package.