Skip to content

Changelog

v0.14.0 (2026-05-20)

Breaking changes

  • Short-term storage method update_pmax_injection was renamed set_pmax_injection to stay coherent with the rest of the code #405

Bug fixes

  • local, sts: remove wrong check on inflow matrix size #404

Miscellaneous

  • chore: improve APIConf documentation #403

v0.13.1 (2026-04-27)

Bug fixes

  • local, sts: additional constraints were saved in a wrong format #398
  • local, xpansion: sensitivity reading failed when empty #397

Miscellaneous

  • chore: use AntaresWeb version 2.31 inside tests #399

v0.13.0 (2026-04-16)

Features

  • output: allow reading ts-numbers results #393

Bug fixes

  • local, run: allow the study to run with sc builder set #395

Miscellaneous

  • doc: move non user-related enums and functions #391
  • output: harmonize code with web #392
  • doc: added doc #381
  • chore: remove unwanted local general parameters #394

v0.12.2 (2026-03-31)

Bug fixes

  • settings: support v9.3 adequacy patch field redispatch #387
  • settings: support v9.3 field accurate_shave_peaks_include_short_term_storage #388

v0.12.1 (2026-03-31)

Bug fixes

  • local, link: remove empty capacities folder inside deletion #383
  • local, constraints: read ids instead of infering based on their names #384

Miscellaneous

  • ci: add ubuntu GUI for daily ci #382

v0.12.0 (2026-03-24)

Compatibility

  • This version is compatible with AntaresWeb v2.30.0. The previous is not for scenario-builder related features, due to a breaking change inside Web API (#370)

  • We removed the argument mc_years inside mc-all aggregation as it did not make sense #377

Bug fixes

  • settings: support expansion as a simulation mode #374

Miscellaneous

  • tests: use AntaresWeb v2.30 inside CI #378
  • sc-builder: simplify API code #379
  • doc: fix README example #375

v0.11.0 (2026-02-24)

Breaking changes

We changed the way the user runs a simulation due to #367

Before

  • Local: The user had to set a solver_path inside read_study_local or create_study_local to be able to run a simulation.
  • API and Local: To give specific solver parameters we used the AntaresSimulationParameters class.

Now

  • Local: To give specific solver parameters we use the AntaresSimulationParametersLocal class. It requires an attribute solver_path.
  • API: We now use the class AntaresSimulationParametersAPI to do the same thing as before.

We expect this to be more user-friendly, and it also allows the user to give more options for API usage. For instance, it's now possible to choose the solver version, the presets defined in the app or other niche options.

Miscellaneous

  • tests: use AntaresWeb v2.29 inside CI #368

v0.10.4 (2026-02-23)

Refactorings

  • thematic-trimming: make the class not frozen for user to modify it #365

v0.10.3 (2026-02-23)

Bug fixes

  • api, move: use unix path inside move method #363

v0.10.2 (2026-02-03)

Bug fixes

  • local, settings: allow other values inside generaldata reading #361

v0.10.1 (2026-02-02)

Features

  • study, local: allow path as string for read / create methods #359

Miscellaneous

  • tests: adapt integration test to new Web behavior #355
  • chore: remove unwanted parameter mutation #356
  • run: remove usage of shell=True #357

v0.10.0 (2026-01-27)

Features

  • thematic-trimming: add new fields #322
  • local, xpansion: support reading and editing new settings #347

Bug fixes

  • local: deleting an area with id != name doesn't delete area #334
  • local: issue inside mass update for clusters and st-storages #341
  • local, sts: issue when updating constraint properties #342
  • local, hydro: issue inside allocation when deleting area #344

Miscellaneous

  • ci: make the CI faster #332
  • api: change matrix headers to always have integers #333
  • deps: update setuptools to ~78.1.1 #335
  • links: avoid dictionary mutation #345
  • tests: use AntaresWeb v2.28 for API tests #346

v0.9.5 (2026-01-13)

Bug fixes

  • local, run: allow simulations to run on Windows 330

v0.9.4 (2026-01-13)

Perfs

  • api, ts-gen: wait less time the task ends 327
  • api, matrix: use arrow to read matrices 328

v0.9.3 (2026-01-09)

Perfs

  • local, output: speed-up aggregation process 325

v0.9.2 (2026-01-09)

Bug fixes

  • local, thematic-trimming: allow unknown fields 323

v0.9.1 (2026-01-08)

Bug fixes

  • api, binding constraints: allow offset to be null inside terms 320

v0.9.0 (2026-01-05)

Features

  • build: support Python 3.14 315

Bug fixes

  • local, hydro: write allocation values to ini file 317

Others

  • deps: use numpy v2 instead of v1 316

v0.8.0 (2025-12-18)

Compatibility

  • The method study.delete_binding_constraint has been replaced by study.delete_binding_constraints where you can now give a list of constraints to delete at the same time 308

Features

  • local, area: implement area deletion 196

Bug fixes

  • local, settings: allow exportmps both-optims value 311
  • local, settings: allow reading with unwanted fields in the generaldata.ini 312
  • local, renewable: consider free groups before v9.3 are other res 1 313
  • local, sc-builder: clean the file when deleting objects 307
  • local, sc-builder: clean it when changing bc group 309

Perfs

  • local, output: faster aggregation for clusters 305

Others

  • tests: use 8.8.19 inside integration tests 310

v0.7.0 (2025-12-12)

Compatibility

  • This version is compatible with AntaresWeb v2.27.0. So does the 0.6.0.

Bug fixes

  • local, thermal: consider free groups before 9.3 are other 1 292
  • local, st-storage: make groups case-insensitive 293
  • local, bc: check matrices coherence at constraint creation 298
  • local, bc: modify matrices when updating constraint time_step or operator 301

Perfs

  • local, output: use polars inside output aggregation 302
  • local, matrix: use polars to read and write input matrices 303

Others

  • ci: use the right desktop name 291
  • doc: more docstrings 144
  • tests: use AntaresWeb 2.27 inside integration tests 300

v0.6.0 (2025-11-07)

Compatibility

  • This version is compatible with AntaresWeb v2.26.0. The previous is not.
  • The following methods concerning binding constraint terms were removed due to this 279:
    • add_terms, delete_term and update_term were replaced by set_terms that takes the given terms and replace existing ones.

Features

  • hydro: support reading and editing allocation 285

Bug fixes

  • dependencies: fix issue with optional fields and pydantic 2.12 281
  • clusters: stop writing cluster names in lowercase inside API 288

Perfs

  • binding-constraints: clean code and improve perfs for local 280
  • api: use new endpoint inside read_study_api 271

Others

  • tests: remove useless API UTs 283
  • tests: add integration API test inside the CI 282
  • tests: launch API integration test with new AWeb API284
  • docs: change package presentation message on pypi 286
  • tests: add daily integration test with latest AntaresWeb code 287

v0.5.0 (2025-10-13)

Compatiblity

  • This version fully supports the Simulator v9.3 251, 277
  • This version is compatible with AntaresWeb v2.25.0. The previous is not.

Bug fixes

  • ts-gen: bump the timeseries generation package to fix an issue 263
  • local: allow clusters with numeric names 268
  • api: fix issue inside area properties reading and mass update 272
  • output: raise when links are given in the wrong order 274
  • deps: add pyarrow inside pyproject.toml 276
  • scenario-builder: only use hydro final level for v9.2+ studies 275

Perfs

  • aggregation: use parquet instead of csv inside output aggregation 273

Others

  • deps: relax dependencies requirements in pyproject.toml 266
  • lint fix linting 269

New Contributors

  • @RobbieKiwi made their first contribution in 268

v0.4.0 (2025-09-16)

Compatiblity

  • This version fully supports the Simulator v9.2

Features

  • thematic-trimming: add BC. MARG. COST 244
  • st-storages: add attributes coherence check 245
  • st-storages: support additional constraints 246
  • local: support 9.2 launcher 249

Bug fixes

  • local: support optional matrices 248
  • local: delete matrices when deleting an object 250
  • api: encode binding constraint term ID inside API call + use the right solver inside simulation 256

Others

  • output: remove columns renaming inside local aggregation 243
  • tests: fix desktop tests 261

Perfs

  • xpansion: remove one API call 247
  • settings: remove some API calls when updating study settings 253

v0.3.0 (2025-07-24)

Features

v0.2.10 (2025-07-16)

Features

  • xpansion: implement inputs reading 227

Bug fixes

  • api: change thematic-trimming to_model method 229

v0.2.9 (2025-07-09)

Compatiblity

  • This version is compatible with AntaresWeb v2.22.1. The previous is not.
  • This version is compatible with Simulator v9.2 except for the short-term storage additional constraints.

Features

  • api: support AntaresWeb 2.22.1 220
  • version: handle Simulator v9.2 179

Breaking changes

  • clusters: forbid creation with matrices for thermal and renewable clusters 219
  • Thermal and renewable clusters can no longer be instantiated with matrices (DataFrame)
  • Before: 
    thermal = area_fr.create_thermal_cluster("cluster_nuclear", series=matrix)
  • After: 
    thermal = area_fr.create_thermal_cluster("cluster_nuclear")
thermal.set_series(matrix)

Bug fixes

  • local: remove useless thermal file 212
  • local: rename matrix C02Cost in CO2Cost 213
  • local: check constraint matrices size at the creation 214
  • local: use different thermal prepro matrices 215
  • local: perform whole data validation before writing data inside mass update methods 216
  • api: allow extra fields from API inside pydantic model 225

Miscellaneous

  • chore: make exception messages a bit clearer 217

v0.2.8 (2025-07-03)

Compatiblity

This version is compatible with AntaresWeb v2.22. The previous is not.

Features

  • bcs: forbid deletion if area/link/cluster is referenced inside a constraint term 195
  • api handle AntaresWeb version 2.22 197

Miscellaneous

  • deps: bump pydantic and move documentation requirements 198
  • sonar: fix little sonar issues 199
  • output: add aggregation enums inside __all__ 200
  • tests: adapt code to custom desktop version 210

v0.2.7 (2025-06-13)

Breaking changes

This version is only compatible with AntaresWeb v2.21.0 and higher due to 188

We also changed the user output interaction due to 186
Example:
Previously: res = output.aggregate_areas_mc_all(query_file="details", frequency="hourly")
Now: res = output.aggregate_mc_all_areas(data_type="details", frequency="hourly")

Features

  • version handle explicitely only v8.8 studies 181
  • local implement local output service 185
  • local use getpass.getuser() when creating a local study 189
  • local add clusters reading inside read_study_local 191

Bug fixes

  • local: allow study reading when there's no output folder 175
  • local: read_areas method relies on study path 176
  • local: support several values for accuracy_on_correlation field 177
  • local: allow area names inside hydro.ini file 178
  • local: fix several issues on cluster group parsing 192
  • settings: allow reading legacy values 193

Miscellaneous

  • build: restore Windows CI 172
  • build: bump ruff and mypy 173
  • local: use antares-study-version package to simplify the code 180
  • build: bump tox 182
  • chore: use mypy inside tests 190

v0.2.6 (2025-04-14)

Bug fixes

  • local: support None value for include-export-mps 169
  • local: allow empty field for accuracy-on-correlation inside generaldata.ini 170

v0.2.5 (2025-04-09)

Features

  • build: support Python3.13 164

Bug fixes

  • local: avoid reading useless fields inside read_settings method 165
  • local: use the default value when reading an empty string 166

v0.2.4 (2025-04-04)

Features

  • renewable: add update_renewable_clusters method 149
  • st-storage: add update_st_storages method 150
  • local support playlist reading and writing 159
  • local support thematic trimming reading and writing 160
  • scenariobuilder: support scenario builder reading and writing 161, 162

Bug fixes

Miscellaneous

  • local use ini_reader instead of ConfigParser to prepare future work 151
  • local avoid unecessary i/o operations inside area properties update 153

v0.2.3 (2025-03-20)

Breaking changes

  • We dropped the support of Python3.9. The supported versions of Python are the 3.10, 3.11 and 3.12
  • Every update_multiple_... method has been renamed in update_...s 145

Features

  • hydro: handle inflow-structure 137
  • adequacy-patch: change default values for 2 fields 141

Bug fixes

  • local: use right st-storage matrices names 140
  • local: several bugs made antares simulation fail 147

Perfs

  • local: avoid multiple i/o operations on the same files inside reading methods 134
  • local: speed-up study.update_thermals methods 142

Miscellaneous

  • chore remove useless read methods 135
  • chore simplify read methods 136
  • chore: clean link code 143

v0.2.2 (2025-03-17)

Bug fixes

  • api: parse horizon inside study settings even when it's an integer

Perfs

  • api: use AntaresWeb table-mode endpoints to reduce amount of API calls inside reading methods

v0.2.1 (2025-03-13)

Compatiblity

This version is only compatible with AntaresWeb v2.19.1 and higher. Consequently, the v0.2.0 is only compatible with AntaresWeb v2.19.0

It also requires a solver in v8.8.14 or higher

Breaking changes

  • areas: new user class for AreaUI. It does no longer support multiple layers 96
  • matrices: rename matrices update methods. The prefixes create or update changed to set for clarity’s sake 125
  • user make read methods inside Study or Area private. You shall no longer need to use them 126

Features

  • user: make user classes frozen to avoid careless modifications 99
  • links: create modify_multiple_links method by 98
  • local: handle st storage methods 101
  • local: handle thermal methods 102
  • local: handle renewable methods 103
  • links: use read_links inside read_study_api105
  • constraints: introduce update_multiple_constraints method 108
  • local: implement read_constraints method 110
  • local: implement some binding_constraints 111
  • local: implement thermal_ts_generation 112
  • local: return default simulator matrices when they are empty 113
  • areas: introduce update_multiple_areas_properties method 104
  • local: handle local launcher 116
  • local: handle delete and read output methods 117
  • local: handle clusters deletion methods 118
  • local: handle link update ui and deletion 120
  • local: implement delete constraint method 123
  • api: handle AntaresWeb version 2.19.1 92
  • thermals: introduce update_multiple_thermal_clusters method 124

Fixes

  • user: read_xxx methods modify objects instead of copying them 100
  • user: put new dependencies inside the pyproject.toml file 129
  • local: write_timeseries method improvement 97
  • local: actually modify ini files inside update methods 119

Miscellaneous

  • doc: initialize doc deployment to readthedoc 121
  • chore: cleaning duplicated code 106
  • chore: better handling of filtering values 114
  • chore: remove pydantic related field from user classes 115
  • chore: put user related classes inside __init__.py 127

Full Changelog: https://github.com/AntaresSimulatorTeam/antares_craft/compare/v0.2.0...v0.2.1

v0.2.0 (2025-02-20)

Compatiblity with AntaresWeb

This version is only compatible with AntaresWeb v2.19.0 and higher

Breaking changes

  • It is no longer possible to create a study while giving settings. The user will have to update them afterward.
  • All user classes are now dataclasses and not Pydantic model.
  • All user class (except for update) have no optional fields meaning it will be clearer for the users to see what they are really sending. It will also silent typing issues inside user scripts
  • New classes have been introduced for update. They are all optional which makes it also clear to understand which fields are updated.
  • STStorage methods for updating matrices have been renamed update_xxx instead of upload_xxx.

Example of an old code: 

import AreaProperties

area_properties = AreaProperties()
area_properties.energy_cost_unsupplied = 10
area_properties.energy_cost_spilled = 4
area_fr = study.create_area("fr", area_properties)

new_properties = AreaProperties()
new_properties.energy_cost_unsupplied = 6
area_fr.update_properties(new_properties)

Example of a new code: 

import AreaProperties, AreaPropertiesUpdate

area_properties = AreaProperties(energy_cost_unsupplied=10, energy_cost_spilled=4)
area_fr = study.create_area("fr", area_properties)

new_properties = AreaPropertiesUpdate(energy_cost_unsupplied=6)
area_fr.update_properties(new_properties)

Features

  • API: add import_study_api method
  • API: add update_thermal_matrices methods
  • API: specify number of years to generate for thermal TS-generation

Fixes

  • LOCAL: get_thermal_matrix method checked the wrong path
  • API: read_renewables method doesn't fail when settings are aggregated instead of clusters
  • API: read_settings doesn't fail when horizon is a year
  • API: disable proxy when using the Desktop version to avoid any issue

Miscellaneous

  • enforce strict type checking with mypy
  • enforce override with mypy
  • Moves all local and api related classes and methods outside the model package

v0.1.8_RC2 (2025-01-22)

  • upload renewable thermal matrices method added
  • bug fix clusters/{area}/list.ini file was missing
  • bug fix for input/thermal/series/{area}/{cluster}/series.txt /data.txt and modulation.txt, wrong path at cluster creation

v0.1.8_RC1 (2025-01-22)

  • bug fixes for missing files when creating area
  • wrong properties corrected (spread-unsupplied-energy-cost and spread-spilled-energy-cost)

v0.1.7 (2025-01-08)

  • move doc generation from ci.yml to publish.yml

v0.1.6 (2025-01-08)

  • Fix concatenate CONCATENATED_README.md files for single Readme at pypi.org

v0.1.5 (2025-01-08)

  • Concatenate .md files for single Readme at pypi.org

v0.1.4 (2025-01-07)

  • Allow read_areas method to read area parameters and ui
  • Add output functionalities (get_matrix, aggregate_values)

v0.1.3 (2024-12-19)

  • Add project requirements inside pyproject.toml to use the package as is
  • Add a subfolder "craft" inside src to rename the package antares.craft for users
  • Add py.typed file to avoid mypy issues in projects importing the package

v0.1.2 (2024-12-18)

Features

  • Read a study
  • Read thermal, renewable clusters and short term storages properties
  • Read load matrix
  • Read link matrices
  • Allow variant creation
  • Allow to run simulation

v0.1.1 (2024-11-26)

  • update token and bump version to publish on PyPi.

v0.1.0 (2024-11-26)

  • First release of the project.