← Back to all sparks
A

antaresread

ANALYTICS
Velocity0.0

R package antaresread by rte-antares-rpackage — release notes from GitHub.

The R reader for Antares Simulator studies, pinned to whatever the simulator ships next

r-packageenergy-modelingapi-compatibilitybreaking-changessimulation
Current state
antaresRead loads Antares Simulator studies from disk or the Antares Web API into R. Its release history maps one-to-one onto simulator versions: 2.9.2 for Antares 9.2, 2.9.3 for 9.3, and the 3.0.x line for the study-format changes that followed. The recurring work is the converted study version format (9.0 becoming 900) which has now been fixed or re-fixed in three consecutive releases, and 3.1.0 turns that churn into a declared breaking change as Antares Web 2.33.0 introduces yet another numbering scheme.
Where it's heading
The package is a compatibility layer whose roadmap is set entirely upstream, and version identity is where it keeps getting cut. The same .getSimOptionsAPI() version-format fix appears in 3.0.0, 3.0.1 and again in 3.1.0 — three passes at one problem, which suggests the API and disk representations of a study version have not converged. Alongside that, API-mode work is displacing disk-mode work: dedicated endpoints for output listing, district definitions, per-area output handling.
Prediction
The next release will most likely track the following Antares Simulator or Antares Web version, and given the 3.1.0 breaking change, a follow-up correcting the new numbering scheme is a reasonable expectation.

Recent moves

  1. 1mo ago

    Breaking: new API study-version numbering from Antares Web 2.33.0

    Declares a breaking change as Antares Web 2.33.0 switches API-mode version numbering again, and adds a dedicated endpoint for listing study outputs. The third consecutive release to touch the study version format, which is now the package's most persistent source of churn.

    View source ↗
  2. 2mo ago

    Reads the new MIN GEN thermal output variable from Antares 9.2

    Updates the variable mapping so the MIN GEN - MWh thermal output introduced in Antares 9.2 is readable, and repeats the converted version-format fix. Straightforward upstream tracking of the kind that drives most releases here.

    View source ↗
  3. 6mo ago

    Fixes area output imports for Antares 9.3 studies

    A bugfix-only major version handling Antares 9.3 area outputs when column sets differ between areas, plus tolerance for missing district properties and case-insensitive date parsing. The version bump reflects the format break upstream rather than new capability here.

    View source ↗
  4. 6mo ago

    Version bump for CRAN release

    A version bump cut solely to publish to CRAN, with no functional content. Packaging bookkeeping between the substantive 2.9.3 and 3.0.0 releases.

    View source ↗
  5. 9mo ago

    Adds support for Antares Simulator 9.3 studies

    Extends reading to Antares Simulator 9.3, picking up new short-term storage properties and updated thematic trimming. The body defers detail to the upstream changelog, which is the standard shape of a version-tracking release in this package.

    View source ↗
  6. 10mo ago

    Adds read_storages_constraints() for Antares 9.2 storage constraints

    Adds a new reader for short-term storage additional constraints alongside expanded cluster parameters and optional time series for Antares 9.2. A genuine addition to the read surface rather than a compatibility patch, which sets it apart from the releases that follow.

    View source ↗