CRAN Version 1.0.1

antaresEditObject 1.0.1

ENHANCEMENT :

• importZipStudyWeb() zip study with new package zipinstead of utils::zip (more faster)
• createLink()/ editLink() check the number of rows of dataLink and tsLink if provided
• updateOptimizationSettings() add missing properties and update possible values by property
• runSimulation() poll each 300s instead of 1s to get the status of the job to avoid too many queries for Antares Web

DOCUMENTATION :

• setThematicTrimming() add example to show how to update a list of variables

BUGFIXES :

• .st_mandatory_params() property efficiencywithdrawal is not a ratio and can be greater than 1.
• createStudy() Since Antares 9.2, property initial-reservoir-levels in generaldata/other preferences is not needed. This property must be removed.
• createClusterST() Ensure that if a storage is created with overwrite set to TRUE, the storage is overwritten
• createLink()/ editLink() booleans is.null(tsLink) and is.null(dataLink) can change inside the function (rollback to previous version)

BREAKING CHANGES :

• api_command_execute() Since Antares Web 2.31.0, the endpoint v1/tasks/<task_id> sends a property returnValue instead of return_value

CRAN version 1.0.0

NEW FEATURES :

createDistrict() uses a specific endpoint to create the district
editDistrict() allows the user to edit a district. Use of a specific endpoint in API mode.
ENHANCEMENT :

createBindingConstraint()/editBindingCOnstraint() : remove depency to readClusterDesc() from antaresRead package
BUGFIXES :

.get_version_solver_from_path_solver() get solver version by running command line instead of searching in the path.
OPTIMIZATION :

createBindingConstraintBulk() reads links and clusters of the study once

CRAN version 0.9.3

antaresEditObject 0.9.3

(cf. Antares v9.3 changelog)

NEW FEATURES :

• createClusterST()/editClusterST() :
  • New properties (allow-overflow, see list of properties according to study version of Antares with storage_values_default())
• createClusterST()/editClusterST() :
  • New dimension of time series (all matrices will be of (8760, N), noting that N >= 1)
  • Suppression of properties (refreshtimeseries,refreshintervalload, refreshintervalhydro, refreshintervalwind, refreshintervalthermal, refreshintervalsolar from settings/generaldata.ini)
• createCluster() :
  • Dynamic groups (The group parameter is now dynamic and has no restrictions. The default group value for Renewable depends on the version: Other RES 1 if < 930, Other if >= 930).
• updateScenarioBuilder() New types of series "sts" and "sta" ("sct apports level" and "sct contraintes") is available

BUGFIXES :

• createBindingConstraint()/editBindingConstraint() do not allow to create/edit a binding constraint if a cluster referenced in a coefficient does not exist.

CRAN version 0.9.2

This version of the package allows you to create/edit/delete a disk study or API from Antares Simulator version 9.2.

A summary of the new features (cf. Antares v9.2 changelog) :

• 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

This new version also includes new features for existing functions and corrections (see changelog).

CRAN version 0.9.0

antaresEditObject 0.9.0

(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

v0.7.1

antaresEditObject 0.7.1
Breaking changes :
createBindingConstraint() / editBindingConstraint() uses metadata to check the group size of time series.
createBindingConstraintBulk() checks consistency of groups passed as parameters and consistency with the study.
importZipStudyWeb() can delete the zipfile and move the study in Antares Web to another folder
delete antaresRead-reexports.R and adjust scripts to have a clean package
removeArea() : send a warning instead of a stop if an area is referenced in a binding constraint coefficient
removeLink() : send a warning instead of a stop if a link is referenced in a binding constraint coefficient
removeCluster() : send a warning instead of a stop if a cluster is referenced in a binding constraint coefficient
createClusterST() : updated with new endpoint API (POST + PUT)
editClusterST() : updated with new endpoint API (PATCH + PUT)
removeCluster()/removeClusterRES()/removeClusterST() updated with new endpoint API (DELETE)
NEW FEATURES (Antares v8.8) :

updateOptimizationSettings() allows the user to update solver.log property
createClusterST() / editClusterST() use new parameters and default values
Add new function api_patch() to put PATCH (httr) request to API
BUGFIXES :

createBindingConstraint() in API mode (for study <v870) created with "hourly" timeStep all the time
createBindingConstraint() / editBindingConstraint() in TEXT mode, bad values in time series
createBindingConstraintBulk() with no VALUES and with a mix
Enable control of matrix dimension in .check_bulk_object_dim() even if the values are not in first position in the list
editLink() : avoid NULL value (default) for arguments filter_synthesis and filter_year_by_year to write an empty string
updateOutputSettings() : in API mode, allow the user to edit the desired property
setPlaylist(): do not send NULL value if the weights are not provided in argument
OTHER UPDATES :

updateGeneralSettings() : replace custom.ts.numbers argument by custom.scenario and deprecate custom.ts.numbers
updateGeneralSettings() : add thematic.trimming argument for edition
DOC :

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

v0.7.0

antaresEditObject 0.7.0
Second-member coupling constraint scenarios

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

createBindingConstraint() / createBindingConstraintBulk()

New parameters group
Parameter values is now list of data.frame
editBindingConstraint()

New parameters group
Parameter values is now list of data.frame
removeBindingConstraint() can now delete coupling constraints from the group parameter.

scenarioBuilder() has 3 new parameters dedicated to use with binding constraints.

updateGeneralSettings() adds coupling constraints to the scenariobuilder.dat file.

Breaking changes :
createBindingConstraint() is available with offset parameter in API mode

v0.6.4

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()

v0.6.3

HOT FIX :
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
returned an updated list of simulation parameters returned by the function setSimulationPath() and setSimulationPathAPI()
.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

v0.6.2

To solve a reverse dependency problem with the next release of the antaresRead package (ci/cd test failed).