CRAN version 3.0.0

BUGFIXES :

• .getSimOptions() reads and returns the new converted study version format (ex : 9.0 => 900) in output mode
• .importOutput() Fixed area outputs import for Antares ≥ 9.3 when output columns differ between areas.
• .readDistrictsDefAPI() treats case when apply-filter property is not written.
• .getStartDate() is case insensitive to treat property first-month-in-year
• .importOutputForAreas()from Antares 9.3, for values files, if select is not null, get all the columns and select the desired ones at the end.

CRAN version 2.9.3

This version of the package allows you to read a disk study or API from Antares Simulator version 9.3.

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

• new properties st-storage
• update/add new thematic

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

CRAN version 2.9.2

This version of the package allows you to read a disk study or API from Antares Simulator version 9.2.

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

• readClusterSTDesc() read new clusters parameters (parameters names are now sorted)
• readInputTS() read new optional time Series (5 time series)
• NEW FUNCTION read_storages_constraints() read properties and time series of a short-term storages/additional constraints

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

CRAN version 2.9.0

antaresRead 2.9.0

(cf. Antares v9 changelog)

NEW FEATURES:

• setSimulationPath() / setSimulationPathAPI() have a new parameter 'verbose' (default to FALSE) to manage diagnostic messages

BUGFIXES :

• setSimulationPathAPI() : encode URL before reading the data in simulation mode
• api_get() : add warn_for_status in importFrom section
• readAntares() : In disk mode, return all the available columns for a short-term storage output and match the column with the content
• .importOutput() : check if output file exists in API mode (.check_output_files_existence())
• .giveSize() : take into account ST clusters in the size computing and use enabled == TRUE or empty enabled for enabled clusters and ST clusters

BREAKING CHANGES :

• setSimulationPathAPI() : reads and returns the new converted study version format (ex : 9.0 => 900)
• readClusterDesc() / readClusterResDesc() / readClusterSTDesc() have a new parameter (dot_format = TRUE) to return two format to display input cluster properties

GITHUB ACTIONS :

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

v2.7.2

antaresRead 2.7.2
NEW FEATURES:

New function readAntaresSTClusters()
fread_antares() shiny compatible with a conditional processing of the error messages
BREAKING CHANGES :

readClusterDesc() / readClusterResDesc() / readClusterSTDesc() are updated with new endpoint "table mode".
In "text" mode, functions return all properties (with default properties) according to study version.
BUGFIXES :

setSimulationPathAPI(): control the existence of the output folder links or areas before reading the data (upgrade Antares Web)
readClusterDesc() / readClusterResDesc() / readClusterSTDesc() return a data.table in API mode

v2.7.1

ON CRAN

NEW FEATURES:

readInputThermal() :
new parameter areas to get desired clusters from selected areas.
new parameter thermalAvailabilities to import time series.
readInputRES() new parameter areas to get desired clusters from selected areas.
setSimulationPath() return a new parameter binding (for studies >= v8.7.0). It contains a table with group dimensions of time series for binding constraints.
readAntares() new parameter clustersST to read (output simulation) short-term clusters
BREAKING CHANGES :

readInputThermal() / readInputRES() default value when no time series in the selected clusters.
BUGFIXES :

readInputThermal() return data from file data.txt with thermalData parameter
setSimulationPath() has also the parameter areasWithSTClusters in 'output' mode

v2.7.0

antaresRead 2.7.0

Breaking changes (Antares v8.7.0) :
readBindingConstraints() read now Scenarized RHS for binding constraints (cf. Antares v8.7 changelog)
function returns a new list structure
Private function fread_antares() no longer returns warnings
api_put()/api_delete() return a server error message
BUGFIXES :

readBindingConstraints() read well study >= v8.3.2
DATA :

A test study in tar.gz format is available in version v8.7.0
An empty test study in version v8.7.0 for marginal cases
Dependencies :

New package lifecycle to manage functions status/package status

v2.6.1

Patch version:
BUGFIXES :

setSimulationPathAPI() :
returns an API exception if the requested study ID is incorrect
simulation the simulation parameter works with negative values within the limit of the number of simulations
correction in readClusterDesc() calls to add "opts"
readAntares() :
returns the right column names for details-timeStep.txt and details-res-timeStep.txt
Correction in .formatlist(), read N-level list instead of 2.
BREAKING CHANGES :

api_get() has a new parameter to control JSON file parsing
readClusterDesc()/ readClusterRESDesc() / readClusterSTDesc() return empty dataTable and warning if no cluster in Antares study.

v2.6.0

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

• readClusterSTDesc() read "short-term storage" clusters parameters (input files of an antares study)

BREAKING CHANGES (Antares v8.6) :

• readInputTS() is now compatible to read time series with :
  • "short-term storage"
  • "mingen" (pmin hydro value)
• setSimulationPath() has new parameter areasWithSTClusters (name of area with "st-storage" cluster)

BUGFIXES :

• setSimulationPathAPI generate new global parameter sleep to add timer to API request
• Correction of .importOutput() to use readAntares() with parallel == TRUE in shiny application
• setSimulationPathAPI() delete a redundant API request
• readClusterDesc() minor fix in API mode + fix if no cluster exists => return specific error message
• readIniAPI() read well file generaldata for sections "playlist" and "variables selection"

DATA :

• A test study in tar.gz format is available in version v8.6.0

v2.5.1

BUGFIXES:

• Major correction to setSimulationPath() (mc-all/mc-ind) (#199)

DEV:

• Added new test study v8.5.
• Package no longer tested on study v6.