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()
NEW FEATURES :
deleteStudy() with new parameter simulation to delete a simulation in an Antares study.geographic.trimming in updateGeneralSettings()to activate or deactivate this general parameter.importZipStudyWeb() to allow the user to import a local study in Antares WebsetPlaylist() optimized for the API mode
setSimulationPath() and setSimulationPathAPI().createCluster() uses data.table::fwrite() instead of utils::write.table() for optimizationcreateCluster() parameter list_pollutants default value to NULL.createBindingConstraint() parameter coefficients must be alphabetically ordered..createCluster() default matrix in API mode.removeArea() :
removeLink() : control the existence of a link a in a binding constraint coefficient before deletionremoveCluster() : control the existence of a cluster a in a binding constraint coefficient before deletioncreateClusterST() : 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.custom-scenario property in generaldata.ini by himselfBUGFIXES :
filter_synthesis and filter_year_by_year parameters of editLink() in API modesetPlaylist() works in API and local mode with weights.getPlaylist() works in API and local mode with weights.createDSR() in API mode : daily binding constraint takes 366 rows.createCluster() and editCluster() parameter list_pollutants stop if Antares Version < 8.6.0getJobs() no longer returns duplicates and displays the two new columns owner_id and owner_name.updateScenarioBuilder()scenarioBuilder() matrix has the same row repeated if the area is not randcreateLink() to update opts in API mode.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() :
removeCluster() no longer deletes everything in the folder preproantaresRead (see cran-comments.md for details)writeInputTS() allows the user to set a link with the separator ’ - ’ (ex: ‘area1 - area2’)BUGFIXES :
createStudy() integrate “st-storage”.createArea() integrate “st-storage”.removeArea() integrate “st-storage”.writeInputTS() integrate “mingen” data and dependency between “mod.txt” and “mingen.txt” data.createCluster() / editCluster() have new parameter list_pollutants for list of pollutants.NEW FEATURES (Antares v8.6) :
activateST() Activate “st-storage” in an Antares study.createClusterST(), editClusterST(), removeClusterST() (“st-storage” family of functions for a study in “input” mode)mingen.txt and mod.txt based on values in hydro.ini filemingen.txt and maxpower.txt based on values in hydro.ini fileenable-first-step in adequacy patch section in settings/generaldata.iniNEW FEATURES :
deduplicateScenarioBuilder() function to keep the last value if a key is duplicated in settings/scenariobuilder.datwriteIniHydro() function to make easier the edition of the input/hydro/hydro.ini filewriteIniHydro() in createArea() and removeArea()settings/scenariobuilder.dat by using scenarioBuilder() and updateScenarioBuilder()deduplicateScenarioBuilder() function to keep the last value if a key is duplicated in settings/scenariobuilder.datwriteIniHydro() function to make easier the edition of the input/hydro/hydro.ini filewriteIniHydro() in createArea() and removeArea()removeArea() removes only expected files in links directorydeleteStudy() no longer requires user confirmationapi_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 descriptiongetPlaylist() is compatible with the new format returned by readIniAPI()removeClusterRES() in API moderemoveLink() delete properly data for an Antares version >= 820rollback_to_previous_data() enable to rollback if original value is NULLwriteInputTS() allows the user to set a link with the separator ’ - ’ (ex: ‘area1 - area2’)BUGFIXES :
api_command_execute() add timer to request apiwriteInputTS() 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 sortedNEW FEATURES :
deleteStudy() (API compatible)copyStudyWeb() to import physical study into a managed study (API).createClusterBulk() to create multiple thermal clusters at once.writeHydroValues() to write hydro input files.backupStudy()BUGFIXES :
removeArea().writeEconomicOptions() in API mode.NEW FEATURES :
convertConfigToAdq() for migration of older adequacy patch studies into v8.5updateAdequacySettings() has new arguments (cf. Antares v8.5 changelog).createColumns() to create headers of output data when missing.cleanUpOutput() to delete any extra output files not selected in simulation.computeOtherFromHourlyMulti() and computeOtherFromHourlyYear() for mc-ind aggregation. computeTimeStampFromHourly() is now deprecated.BUGFIXES :
writeOutput() and writeAntaresOutput() (support V8)editClusterRES()createClusterRES()getPlaylist() and setPlaylist() in API modeBUGFIXES :
editCluster() in API modecreateVariant()createCluster() and createClusterRES()result-format to choose output format (txt/zip) + new values for transmission-capacities parameter.updateAdequacySettings() function to activate Adequacy Patch and set parameters. + createArea() and editArea() support for new adequacy_patch.ini file.createLink() and editLink() have a new argument tsLink allowing to write transmission capacities time-series.createBindingConstraintBulk() allow to create multiple binding constraints at once.writeInputTS() has changed, data is now in first place.This release include some new features to interact with Antares Web.
createArea(), editArea(), removeArea(), createLink(), editLink(), removeLink(), createCluster(), editCluster(), removeCluster(), createBindingConstraint(), editBindingConstraint(), removeBindingConstraint(), createDistrict(), updateGeneralSettings(), updateInputSettings(), updateOptimizationSettings(), updateOutputSettings(), updateAdequacySettings(), writeInputTS(), readScenarioBuilder(), updateScenarioBuilder(), clearScenarioBuilder(), writeWaterValues(), createDSR(), createPSP().useVariant(), createVariant().createStudyAPI().searchStudy().setAPImode().createStudy() no longer return TRUE / FALSE, but simulation options list returned by antaresRead::setSimulationPath().This release include some new features to interact with renewable energy sources (new in Antares v8.0.3):
activateRES() to use new RES features in an Antares study.updateOptimizationSettings() has a new argument renewable.generation.modelling that can take as value: NULL|aggregated|cluster.createClusterRES() to create a new renewable cluster.editClusterRES() to edit an existing renewable cluster.removeClusterRES() to remove a renewable cluster.readScenarioBuilder(): there can be a new field r if a scenario is completed for renewablesupdateScenarioBuilder(): allow to update scenario builder for renewables if RES activated.updateGeneralSettings(): check value for inter.modal and inter.modal parameters:
updateInputSettings(): prevent use of renewables for import parameter.updateScenarioBuilder() has a new argument clusters_areas = <data.table> to specify area/cluster to use for thermal/renewable series.clearScenarioBuilder() to clear a ruleset from the scenario builder.getPlaylist : V8 antares ponderation.setPlaylist : V8 antares ponderation.copyOutput : to copy antares output with extension.writeOutputValues : to write antares data after antaresRead (areas, links and clusters).computeTimeStampFromHourly : to write mc-ind data from hourly files (daily, weekly, monthly and annual).parAggregateMCall : to compute mc-all from md-ind.editArea : to edit an area.editBindingConstraint : to edit a Binding Constraint.createStudy() for Antares version >= 7.1.0writeSeriesPrepro(): to write load, wind and solar prepro data.writeInputTS(): writes input time series.scenarioBuilder() can write thermal scenario.writeEconomicOptions(): to create or edit economic options.nodalOptimizationOptions() has two new arguments: average_unsupplied_energy_cost and average_spilled_energy_cost.scenarioBuilder() now work when areas_rand has length 1createPSP to work with Antares v7NEWS.md file to track changes to the package.