`, etc.) that has more than one element. Defaults to 1 (for ``).
+ getTopLevel: function($scope) {
+ for (var i = 1; i <= 6; i++) {
+ var $headings = this.findOrFilter($scope, 'h' + i);
+ if ($headings.length > 1) {
+ return i;
+ }
+ }
+
+ return 1;
+ },
+
+ // returns the elements for the top level, and the next below it
+ getHeadings: function($scope, topLevel) {
+ var topSelector = 'h' + topLevel;
+
+ var secondaryLevel = topLevel + 1;
+ var secondarySelector = 'h' + secondaryLevel;
+
+ return this.findOrFilter($scope, topSelector + ',' + secondarySelector);
+ },
+
+ getNavLevel: function(el) {
+ return parseInt(el.tagName.charAt(1), 10);
+ },
+
+ populateNav: function($topContext, topLevel, $headings) {
+ var $context = $topContext;
+ var $prevNav;
+
+ var helpers = this;
+ $headings.each(function(i, el) {
+ var $newNav = helpers.generateNavItem(el);
+ var navLevel = helpers.getNavLevel(el);
+
+ // determine the proper $context
+ if (navLevel === topLevel) {
+ // use top level
+ $context = $topContext;
+ } else if ($prevNav && $context === $topContext) {
+ // create a new level of the tree and switch to it
+ $context = helpers.createChildNavList($prevNav);
+ } // else use the current $context
+
+ $context.append($newNav);
+
+ $prevNav = $newNav;
+ });
+ },
+
+ parseOps: function(arg) {
+ var opts;
+ if (arg.jquery) {
+ opts = {
+ $nav: arg
+ };
+ } else {
+ opts = arg;
+ }
+ opts.$scope = opts.$scope || $(document.body);
+ return opts;
+ }
+ },
+
+ // accepts a jQuery object, or an options object
+ init: function(opts) {
+ opts = this.helpers.parseOps(opts);
+
+ // ensure that the data attribute is in place for styling
+ opts.$nav.attr('data-toggle', 'toc');
+
+ var $topContext = this.helpers.createChildNavList(opts.$nav);
+ var topLevel = this.helpers.getTopLevel(opts.$scope);
+ var $headings = this.helpers.getHeadings(opts.$scope, topLevel);
+ this.helpers.populateNav($topContext, topLevel, $headings);
+ }
+ };
+
+ $(function() {
+ $('nav[data-toggle="toc"]').each(function(i, el) {
+ var $nav = $(el);
+ Toc.init($nav);
+ });
+ });
+})();
diff --git a/dev/docsearch.css b/dev/docsearch.css
new file mode 100644
index 00000000..e5f1fe1d
--- /dev/null
+++ b/dev/docsearch.css
@@ -0,0 +1,148 @@
+/* Docsearch -------------------------------------------------------------- */
+/*
+ Source: https://github.com/algolia/docsearch/
+ License: MIT
+*/
+
+.algolia-autocomplete {
+ display: block;
+ -webkit-box-flex: 1;
+ -ms-flex: 1;
+ flex: 1
+}
+
+.algolia-autocomplete .ds-dropdown-menu {
+ width: 100%;
+ min-width: none;
+ max-width: none;
+ padding: .75rem 0;
+ background-color: #fff;
+ background-clip: padding-box;
+ border: 1px solid rgba(0, 0, 0, .1);
+ box-shadow: 0 .5rem 1rem rgba(0, 0, 0, .175);
+}
+
+@media (min-width:768px) {
+ .algolia-autocomplete .ds-dropdown-menu {
+ width: 175%
+ }
+}
+
+.algolia-autocomplete .ds-dropdown-menu::before {
+ display: none
+}
+
+.algolia-autocomplete .ds-dropdown-menu [class^=ds-dataset-] {
+ padding: 0;
+ background-color: rgb(255,255,255);
+ border: 0;
+ max-height: 80vh;
+}
+
+.algolia-autocomplete .ds-dropdown-menu .ds-suggestions {
+ margin-top: 0
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion {
+ padding: 0;
+ overflow: visible
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--category-header {
+ padding: .125rem 1rem;
+ margin-top: 0;
+ font-size: 1.3em;
+ font-weight: 500;
+ color: #00008B;
+ border-bottom: 0
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--wrapper {
+ float: none;
+ padding-top: 0
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column {
+ float: none;
+ width: auto;
+ padding: 0;
+ text-align: left
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--content {
+ float: none;
+ width: auto;
+ padding: 0
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--content::before {
+ display: none
+}
+
+.algolia-autocomplete .ds-suggestion:not(:first-child) .algolia-docsearch-suggestion--category-header {
+ padding-top: .75rem;
+ margin-top: .75rem;
+ border-top: 1px solid rgba(0, 0, 0, .1)
+}
+
+.algolia-autocomplete .ds-suggestion .algolia-docsearch-suggestion--subcategory-column {
+ display: block;
+ padding: .1rem 1rem;
+ margin-bottom: 0.1;
+ font-size: 1.0em;
+ font-weight: 400
+ /* display: none */
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--title {
+ display: block;
+ padding: .25rem 1rem;
+ margin-bottom: 0;
+ font-size: 0.9em;
+ font-weight: 400
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--text {
+ padding: 0 1rem .5rem;
+ margin-top: -.25rem;
+ font-size: 0.8em;
+ font-weight: 400;
+ line-height: 1.25
+}
+
+.algolia-autocomplete .algolia-docsearch-footer {
+ width: 110px;
+ height: 20px;
+ z-index: 3;
+ margin-top: 10.66667px;
+ float: right;
+ font-size: 0;
+ line-height: 0;
+}
+
+.algolia-autocomplete .algolia-docsearch-footer--logo {
+ background-image: url("data:image/svg+xml;utf8,");
+ background-repeat: no-repeat;
+ background-position: 50%;
+ background-size: 100%;
+ overflow: hidden;
+ text-indent: -9000px;
+ width: 100%;
+ height: 100%;
+ display: block;
+ transform: translate(-8px);
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--highlight {
+ color: #FF8C00;
+ background: rgba(232, 189, 54, 0.1)
+}
+
+
+.algolia-autocomplete .algolia-docsearch-suggestion--text .algolia-docsearch-suggestion--highlight {
+ box-shadow: inset 0 -2px 0 0 rgba(105, 105, 105, .5)
+}
+
+.algolia-autocomplete .ds-suggestion.ds-cursor .algolia-docsearch-suggestion--content {
+ background-color: rgba(192, 192, 192, .15)
+}
diff --git a/dev/docsearch.js b/dev/docsearch.js
new file mode 100644
index 00000000..b35504cd
--- /dev/null
+++ b/dev/docsearch.js
@@ -0,0 +1,85 @@
+$(function() {
+
+ // register a handler to move the focus to the search bar
+ // upon pressing shift + "/" (i.e. "?")
+ $(document).on('keydown', function(e) {
+ if (e.shiftKey && e.keyCode == 191) {
+ e.preventDefault();
+ $("#search-input").focus();
+ }
+ });
+
+ $(document).ready(function() {
+ // do keyword highlighting
+ /* modified from https://jsfiddle.net/julmot/bL6bb5oo/ */
+ var mark = function() {
+
+ var referrer = document.URL ;
+ var paramKey = "q" ;
+
+ if (referrer.indexOf("?") !== -1) {
+ var qs = referrer.substr(referrer.indexOf('?') + 1);
+ var qs_noanchor = qs.split('#')[0];
+ var qsa = qs_noanchor.split('&');
+ var keyword = "";
+
+ for (var i = 0; i < qsa.length; i++) {
+ var currentParam = qsa[i].split('=');
+
+ if (currentParam.length !== 2) {
+ continue;
+ }
+
+ if (currentParam[0] == paramKey) {
+ keyword = decodeURIComponent(currentParam[1].replace(/\+/g, "%20"));
+ }
+ }
+
+ if (keyword !== "") {
+ $(".contents").unmark({
+ done: function() {
+ $(".contents").mark(keyword);
+ }
+ });
+ }
+ }
+ };
+
+ mark();
+ });
+});
+
+/* Search term highlighting ------------------------------*/
+
+function matchedWords(hit) {
+ var words = [];
+
+ var hierarchy = hit._highlightResult.hierarchy;
+ // loop to fetch from lvl0, lvl1, etc.
+ for (var idx in hierarchy) {
+ words = words.concat(hierarchy[idx].matchedWords);
+ }
+
+ var content = hit._highlightResult.content;
+ if (content) {
+ words = words.concat(content.matchedWords);
+ }
+
+ // return unique words
+ var words_uniq = [...new Set(words)];
+ return words_uniq;
+}
+
+function updateHitURL(hit) {
+
+ var words = matchedWords(hit);
+ var url = "";
+
+ if (hit.anchor) {
+ url = hit.url_without_anchor + '?q=' + escape(words.join(" ")) + '#' + hit.anchor;
+ } else {
+ url = hit.url + '?q=' + escape(words.join(" "));
+ }
+
+ return url;
+}
diff --git a/dev/index.html b/dev/index.html
new file mode 100644
index 00000000..f58ca01c
--- /dev/null
+++ b/dev/index.html
@@ -0,0 +1,281 @@
+
+
+
+
+
+
+
+Import, Manipulate and Explore the Results of an Antares Simulation • antaresRead
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Read data from an Antares study with R package ‘antaresRead’
+
+
+
+
+Installation
+
+You can install the package from CRAN:
+
+install.packages("antaresRead")
+You can also install the last development version from Github:
+
+devtools::install_github("rte-antares-rpackage/antaresRead")
+To display the help of the package and see all the functions it provides, type:
+
+help(package="antaresRead")
+To see a practical example of use of the package, look at the vignette :
+
+vignette("antares")
+Finally, you can download a cheatsheet that summarize in a single page how to use the package: https://github.com/rte-antares-rpackage/antaresRead/raw/master/cheat_sheet/antares_cheat_sheet_en.pdf .
+See website for more documentation: https://rte-antares-rpackage.github.io/antaresRead/
+
+
+Initialisation
+
+Load the package
+
+Select an Antares simulation interactively.
+
+You can also select it programmatically:
+
+setsimulationPath("study_path", simulation)
+The parameter simulation can be the name of a simulation, the name of the folder containing the simulation results, or the index of the simulation. 1 corresponds to the oldest simulation, -1 to the newest one, 0 to the inputs.
+
+
+Read data from a simulation
+
+Most data from a simulation can be imported in the R session with function readAntares(). It has many parameters that control what data is imported. Here are a few examples:
+
+# Read synthetic results of all areas of a study with hourly time step.
+areaData <- readAntares(areas = "all")
+
+# Same but with a daily time step:
+areaData <- readAntares(areas = "all", timeStep = "daily")
+
+# Read all Monte Carlo scenarios for a given area.
+myArea <- readAntares(areas = "my_area", mcYears = "all")
+
+# Same but add miscelaneous production time series to the result
+myArea <- readAntares(areas = "my_area", mcYears = "all", misc = TRUE)
+
+# Read only columns "LOAD" and "MRG. PRICE"
+areaData <- readAntares(areas = "all", select = c("LOAD", "MRG. PRICE"))
+Functions getAreas and getLinks are helpful to create a selection of areas or links of interest. Here are a few examples:
+
+# select areas containing "fr"
+myareas <- getAreas("fr")
+
+# Same but remove areas containing "hvdc"
+myareas <- getAreas("fr", exclude = "hvdc")
+
+# Get the links that connect two of the previous areas
+mylinks <- getLinks(myareas, internalOnly = FALSE)
+
+# Get the results for these areas and links
+mydata <- readAntares(areas = myareas, links = mylinks)
+
+
+Work with the imported data
+
+When only one type of elements is imported (only areas or only links, etc.) readAntares() read antares returns a data.table with some extra attributes. A data.table is a table with some enhanced capacities offered by package data.table. In particular it provides a special syntax to manipulate its content:
+
+name_of_the_table[filter_rows, select_columns, group_by]
+Here are some examples:
+
+# Select lines based on some criteria
+mydata[area == "fr" & month == "JUL"]
+
+# Select columns, and compute new ones
+mydata[, .(area, month, load2 = LOAD^2)]
+
+# Aggregate data by some variables
+mydata[, .(total = sum(LOAD)), by = .(month)]
+
+# All three operations can be done with a single line of code
+mydata[area == "fr", .(total = sum(LOAD)), by = .(month)]
+
+help(package = "data.table")
+If you are not familiar with package data.table, you should have a look at the documentation and especially at the vignettes of the package:
+
+
+
+Contributing:
+
+Contributions to the library are welcome and can be submitted in the form of pull requests to this repository.
+The folder test_case contains a test Antares study used to run automatic tests. If you modifies it, you need to run the following command to include the modifications in the tests:
+
+
+
+ANTARES :
+
+Antares is a powerful software developed by RTE to simulate and study electric power systems (more information about Antares here : https://antares-simulator.org/).
+ANTARES is now an open-source project (since 2018), you can download the sources here if you want to use this package.
+
+
+License Information:
+
+Copyright 2015-2016 RTE (France)
+
+- RTE: https://www.rte-france.com
+
+
+This Source Code is subject to the terms of the GNU General Public License, version 2 or any higher version. If a copy of the GPL-v2 was not distributed with this file, You can obtain one at https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dev/link.svg b/dev/link.svg
new file mode 100644
index 00000000..88ad8276
--- /dev/null
+++ b/dev/link.svg
@@ -0,0 +1,12 @@
+
+
+
diff --git a/dev/news/index.html b/dev/news/index.html
new file mode 100644
index 00000000..21abe950
--- /dev/null
+++ b/dev/news/index.html
@@ -0,0 +1,574 @@
+
+Changelog • antaresRead
+
+
+
+
+
+
+
+
+
+
+ Changelog
+ Source: NEWS.md
+
+
+
+antaresRead 2.7.2.9000
+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
+
+
+antaresRead 2.7.12024-08-30
+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
+
+
+antaresRead 2.7.02024-05-28
+
+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
+
+
+
+antaresRead 2.6.2
+BUGFIXES : * readIniFile() : avoid utils::type.convert on specific cases (ex : 789e or 123i) * api_get() add encoding argument to pass to httr::content()
+
+
+antaresRead 2.6.12024-04-22
+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
+-
+
readInputThermal() default value when no time series in the selected clusters.
+-
+
readInputRES() default value when no time series in the selected clusters
+-
+
readClusterDesc()/ readClusterRESDesc() / readClusterSTDesc() return empty dataTable and warning if no cluster in Antares study.
+
+
+antaresRead 2.6.02023-08-30
+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
+
+
+
+antaresRead 2.5.12023-04-06
+BUGFIXES:
+- Major correction to
setSimulationPath() (mc-all/mc-ind) (#199)
+
DEV:
+- Added new test study v8.5.
+- Package no longer tested on study v6.
+
+
+antaresRead 2.5.02023-03-13
+NEW FEATURES:
+- Full support of studies up to v8.5
+- Function
readAntares() has new argument for binding constraints output (v8.4+) (#173)
+- New functions
readDigestFile(), mergeDigests() and writeDigest() to manipulate digest file.
+- Mc-all aggregation :
+
- added computation of record years
+- merges original
digest.txt with the one created
+- loads original
thermal.txt
+
+
+
BUGFIXES:
+- Major corrections to mc-all and mc-ind aggregation (LOLP, H. LEV)
+- Fixed existing write digest.txt part in mc-all aggregation
+- Fixed copy of original links in mc-all aggregation
+
+
+antaresRead 2.4.22023-02-14
+NEW FEATURES:
+- New function
getGeographicTrimming() returns filtering options for selected areas (links optional).
+- New function
readInputRes() for reading renewable clusters input data
+- Existing function
getLinks() now has a new argument withTransmission. if TRUE, return additional column with type of transmission capacities.
+- Existing function
readInputThermal() : added new argument for thermalData
+
+
+antaresRead 2.4.1
+NEW FEATURES:
+Added new functions readInputThermal() and readAntaresClusters() : Both functions take a vector of clusters instead of areas * readInputThermal() : read thermal TS (availabilities) and modulation in Input mode * readAntaresClusters() : read output data for clusters only with thematic trimming
+
+
+antaresRead 2.4.0
+NEW FEATURES:
+Major upgrade to aggregateResult() and parAggregateMCall() : * Faster & memory efficient * Support for Antares studies up to v8.3 (v8.4 experimental) * Dynamic timestep detection * Creation of grid folder * Recycling of original mc-all data
+
+
+antaresRead 2.3.2
+NEW FEATURES:
+added “profit by cluster” when reading cluster data.
+BUGFIXES:
+Fix for 404 error when some output is missing in API mode(#188).
+
+
+
+antaresRead 2.3.02022-10-10
+- Interact directly with AntaREST API with
api_get(), api_post(), api_put(), api_delete().
+- New function to read ini files :
readIni().
+
+
+antaresRead 2.2.97
+FEATURES:
+- NTC by monte carlo years, antares 8.2 update
+
- Update readInputTS when linkCapacity argument is used
+- New link inputs
+
+
+
+
+antaresRead 2.2.952022-03-01
+BUGFIXES:
+- removeVirtualAreas : setting custom prodVars same as new storageVars
+- API : fix study checking + httr options
+
+
+antaresRead 2.2.92021-11-06
+FEATURES:
+- Add ENR Cluster support (V8.1)
+- removeVirtualAreas : Can pass storageFlexibility named list
+- removeVirtualAreas : add prodVars, costsVars and costsOn arguments
+- fix linCapacity aggregation
+
BUGFIXES:
+- aggregateResult parallel export (#161)
+
+
+
+antaresRead 2.2.72021-06-08
+FEATURES:
+- Fixed bugs in
readInputTS() for hydroStorage
+
+- New
hvdcModification() function
+- Add MC Weight functionnality
+- First antares api support
+
+
+antaresRead 2.2.52020-03-18
+FEATURES:
+- Fixed bugs in
removeVirtualAreas() in getLinks()
+
+- Updated documentation & added pkgdown website
+
+
+
+
+
+
+antaresRead 2.2.0 (2018-09-28)2018-09-28
+BREAKING CHANGES:
+- “removeVirtualAres()” : as a new logical parameter rowBal, if is TRUE (default) then BALANCE will be corrected by ROW. BAL (#antaresProcessing33)
+
NEW FEATURES:
+- “removeVirtualAres()” : now correct BALANCE, COST and production of disticts.(#119)
+
BUGFIXES:
+- “readLayout()” : prevent bug reading multiple studies
+- “readAntares()” : prevent bug dealing with integer64
+- “writeAntaresH5()” was not working anymore due to a new version of rhdf5 (h5close() does not work anymore). (#110)
+
+
+antaresRead 2.1.2 (2018-06-01)2018-06-04
+BUGFIXES:
+- getLinks() was sending an error when there are no links in the study.
+
+
+
+antaresRead 2.1.0 (2018-02-23)2018-02-23
+NEW FEATURES:
+- readInputTS() has a new parameter “thermalOutages” that permits to read thermal outages characteristics
+- Call removeVirtualAreas several times in writeAntaresH5()
+
BUGFIXES:
+- Correction of some bugs in removeVirtualAreas when there is several virtual nodes of production and storageFlexibility
+- Correction of some bugs due to the new lubridate version
+
+
+antaresRead 2.0.2 (2017-11-21)2017-11-21
+BUGFIXES:
+- Some tests failed in some platforms on CRAN.
+
+
+antaresRead 2.0.1 (2017-11-14)2017-11-14
+BUGFIXES:
+- readLayout() was not taking a list of simOptions.
+
+
+antaresRead 2.0.0 (2017-11-03)2017-11-06
+NEW FEATURES:
+- New function “writeAntaresH5()” convert ANTARES outputs to h5 files.
+- The path parameter of “setSimulationPath()” can be a h5 file.
+- New function “isH5Opts()” test if the value returned by setSimulationPath() is referring to an h5 file.
+- New function “readOptimCriteria()” read the value of the criteria optimized by ANTARES.
+- New function “setRam()” specify RAM limit (in Go) of the value returned by readAntares, initially it is 10Go.
+- New vignette “antaresH5” is available.
+
BUGFIXES:
+- removeVirtualAreas() was not moving clusters from virtual production area to the real area.
+- antaresRead() sometimes returned a antaresDataList with element “thermalModulation”. (#51)
+
+
+antaresRead 1.1.4 (2017-07-07)2017-07-11
+BUGFIXES:
+- setSimulation() was crashing with antares v6.0 because of the folder “maps”. (#49)
+
+
+antaresRead 1.1.3 (2017-05-30)2017-05-30
+BUGFIXES:
+- readInputTS was crashing when trying to import cluster data and some clusters were disabled.
+
+
+antaresRead 1.1.2 (2017-04-18)2017-04-20
+BUGFIXES:
+- Fixed an issue that caused compilation to crash on mac OS X
+
+
+antaresRead 1.1.0 (2017-03-31)
+NEW FEATURES:
+- The ‘select’ parameter of readAntares() has been improved. It now accepts new keywords “areas”, “links”, “clusters”, “districts” to indicate which type of data to read,“mcYears” to import detailed results, “misc”, “mustRun”, etc. to import the corresponding input data.
+- A new function setAlias() has been added. It permits to packages developers to define new aliases to use in the ‘select’ parameter of readAntares() in order to help their users to import the required data.
+- readBindingConstraints() has been improved and returns an object of class ‘bindingConstraints’ which is a named list where each element has the same structure.
+- A summary method has been added for objects of class ‘bindingConstraints’. It is useful to quickly look at the binding contraints defined in a study.
+- readAntares(mustRun = TRUE) now adds a new column “thermalPmin”. It is similar to mustRunTotal, except it also takes into account the minimum stable power of the cluster units.
+
BUGFIXES:
+- Columns ‘pumpingCapacity’ and ‘storageCapacity’ created by removeVirtualAreas() were reversed.
+- setSimulationPath() was sometimes setting a start data that was not consistent with parameters “1st january” and “leap year”.
+- setSimulationPath() was not working if synthetic results and the first Monte-Carlo scenario were not saved in a given Antares simulation.
+- readAntares(clusters = “all”) was not working in some situations.
+
+
+antaresRead 1.0.0 (2017-02-23)
+BUGFIXES:
+- In some specific situations, date columns could be filled with NA values. (#26)
+- Many small problems that were detected by R CMD CHECK.
+
+
+antaresRead 0.15 (2017-01-25)
+BREAKING CHANGES:
+- Parameter “synthesis” has been removed from readAntares. The new behavior is now to import synthetic results when “mcYears” is NULL and to import detailed results when “mcYears” is set.
+
NEW FEATURES:
+- New function “getIdCols()” returns the Id columns of an antaresDataTable object.
+- New method “subset()” for antaresDataList objects permits to quickly extract the data for a given area or a given Monte-Carlo scenario.
+
BUGFIXES:
+- In “input” mode, getLinks() could return links that did not exist anymore.
+- removeVirtualAreas was requiring some data that was not necesary. It should be OK now.
+- setSimulationPath() was crashing when one wanted to read the input data of a study before having run any simulation.
+- Variable “timeId” is now always numeric. Before it was numeric except for annual data where it could be character or factor.
+
+
+antaresRead 0.14 (2016-11-14)
+NEW FEATURES:
+- readAntares() has been significantly improved. Depending on the query, the time needed to import data is decreased by 20% up to 95%. In particular, importing data for clusters is now 20 times faster than before. Moreover, the progress bar is now more precise.
+- removeVirtualAreas() has a new parameter “newCols” that permits to choose whether to create new columns containing the production of the virtual areas or to update the existing ones.
+- removeVirtualAreas() now also removes virtual links from the data. Before it was removing virtual areas but keeping the virtual links.
+- If the transmission capacity of the links is present in the data, removeVirtualAreas() now creates two new columns containing the capacity of pumping and storage of areas. These columns are used to compute upward and downward margins.
+- New functions as.antaresDataTable and as.antaresDataList have been added to convert compatible objects to these classes.
+
+
+antaresRead 0.13 (2016-10-06)
+BREAKING CHANGES:
+- add a file LICENSE and copyright to sources files
+
+
+antaresRead 0.12 (2016-08-17)
+BREAKING CHANGES:
+- The object returned by ‘setSimulationPath’ and ‘simOptions’ has been modified. In particular, paths have been renamed to make their utility clearer. Moreover a new element named ‘linksDef’ contains a table with the specification of each link of the study.
+
NEW FEATURES:
+- getLinks() can now return a table with the specification of the links, thanks to two new parameters “namesOnly” and “withDirection”
+- It is now possible to import several times the same Monte-Carlo scenario. This can be useful for performance test or to use bootstrap methods.
+
BUGFIXES:
+- readClusterDesc was not working in input mode.
+- Sometimes setSimulationPath changed working directory.
+- Solved some performance issues in readAntares() and removeVirtualAreas().
+
+
+antaresRead 0.11 (2016-08-01)
+BREAKING CHANGES:
+- The parameters of ‘getLinks’ have been modified because they were unclear. Now user has to to explicitly specify areas to include and/or exclude.
+
BUGFIXES:
+- setSimulationPath was crashing if parameter ‘horizon’ was not set in Antares.
+- changeTimeStep sometimes generated NA values because of integer overflow.
+
+
+antaresRead 0.10 (2016-07-18)
+BREAKING CHANGES: * Variable mustRunModuction has been renamed minGenModulation for consistency with Antares * Similarly in the object returned by setSimulationPath and simOptions, “setList” has been renamed “districtList”
+NEW FEATURES: * Now, when one filters, add, remove or update columns of an object of class ‘antaresDataTable’, the result is still of class ‘antaresDataTable’.
+
+
+antaresRead 0.9.1 (2016-07-05)
+BUGFIXES:
+- readAntares was incorrectly setting attributes of its ouput. This resulted in errors when using functions of the antaresProcessing package.
+
+
+antaresRead 0.9 (2016-07-04)
+BREAKING CHANGES:
+- The columns returned by readAntares when ‘hydroStorageMaxPower = TRUE’ have been renamed.
+
NEW FEATURES:
+- readAntares has a new parameter “thermalModulation” to import modulation time series.
+- New aliases have been added. One can inspect them with “showAliases()”.
+
+
+antaresRead 0.8 (2016-06-20)
+NEW FEATURES:
+- setSimulationPath nows reads costs of unsupplied et spilled energy.
+- ReadLayout computes coordinates for districts and link between them.
+- getAreas has a new parameter “district” to get areas in a set of districts.
+- getLinks has new parameter “areas” to get links connected to a set of areas.
+
BUGFIXES:
+- Small bug fixes that avoid useless warning messages/
+
+
+antaresRead 0.7 (2016-06-07)
+BREAKING CHANGES:
+- The package has been renamed “antaresRead”.
+
NEW FEATURES:
+- changeTimeStep accepts two new functions : min and max.
+- readAntares now computes the number of available units.
+
BUGFIXES:
+- setSimulationPath was crashing if parameter “horizon” was not set in Antares.
+- setSimulationPath throws a warning when two simulations have same name and it uses the most recent one.
+- In presence of hubs and production nodes, removeVirtualAreas treated production nodes two times.
+- Column “month” was sometimes numeric and other times character.
+- setSimulationPath was not recognising option “apply-filter = add-all” when retrieving district definition.
+
+
+antaresRead 0.6 (2016-05-27)
+NEW FEATURES:
+- readAntares and readInputTS always add time columns (time, day, month, hour). changeTimeStep now keeps them if they are present.
+
BUGFIXES:
+- readAntares may not work when some MC years were not exported by Antares.
+- The construction of the weeks was wrong when a year did not start on january.
+- The import of inputs was wrong when the study was not conducted on a whole year but on a smaller period.
+- In removeVirtualNodes, option “reassignCosts” was not working correctly.
+
+
+antaresRead 0.5 (2016-05-11)
+BREAKING CHANGES:
+- To be consistent with Antares, ‘node’ has been replaced by ‘area’ everywhere in the package.
+- Column ‘MWh’ is now named ‘production’ when reading clusters output.
+
NEW FEATURES:
+- new function ‘readInputTS’ to read input time series (without output time series)
+- ‘setSimulationPath’ now accepts two new values for the argument “simulation”: 0 and “input”. These values indicate that the user is not interested by the results of any simulation and only wants to read input data.
+- changeTimeStep now accepts for parameter ‘fun’ a vector of function names that indicate how to aggregate/disagregate each column.
+- getAreas has a new argument “withClustersOnly” to select areas containing clusters
+- readAntares can now also add input time series to districts like it does for areas
+
BUGFIXES:
+- ‘copyToClipboard’ was copying the word “txt” instead of copying data
+- ‘removeVirtualNodes’ was not creating some columns for production virtual nodes.
+- The option ‘mustRun’ in readAntares was not functionning correctly
+
+
+antaresRead 0.4 (2016-04-29)
+BREAKING CHANGES:
+- The parameters and the output of “readAntares” have been modified. The output has now only three components: nodes, links and clusters. If the user asks other information like hydro storage or links capacities, they are added to the corresponding component. The corresponding parameters now expect TRUE/ FALSE instead of a vector of node or link names.
+- “getLinks” has now same parameters and behavior than “getNodes”
+- Parameter “trace” has been removed in “setSimulationPath”.
+
NEW FEATURES:
+- “readAntares” has a new argument “mustRun”
+- “removeVirtualNodes” has been finalised
+- New function “simOptions” to get either global simulation options or simulation options used by “readAntares” to create a given object
+- New alias “nosum” to remove “min”, “max”, and “std” columns when “synthesis=TRUE” in “readAntares”
+- “setSimulationPath” has a new argument “simulation” to choose a simulation by name or by order inside an antares project
+- New function “getDistricts”
+- New function “copyToClipboard”
+- Added package vignette
+
+
+antaresRead 0.3 (2016-04-14)
+NEW FEATURES:
+- “readAntares” can now read hydro storage, hydro storage maximum power, reserve and links capacity
+- New function “readAntaresNodes”: read all the desired data for a set of nodes
+- New function “readBindingConstraints”
+- New function “changeTimeStep”: change the timestep of an “antaresOutput” object or any table containing a variable timeId
+- New function “getNodes”: select and filter nodes of an antares study
+- “extractDataList” has been improved for better compatibility with PPSE scripts
+- Improved documentation
+- New function removeVirtualNodes (still experimental)
+- Added this NEWS file :)
+
+
+antaresRead 0.2 (2016-04-05)
+BREAKING CHANGES:
+- “readOutput” has been renamed “readAntares”
+
NEW FEATURES:
+- “readAntares” can now read thermal availabilities
+- “setSimulationPath” now reads simulation parameters
+- “setSimulationPath” now accepts path to a study and eventually asks the user to choose an output
+- Nodes and sets are now separated in “readAntares” and “setSimulationPath”
+- aliases for groups of variables in parameter “select” of “readAntares”
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dev/pkgdown.css b/dev/pkgdown.css
new file mode 100644
index 00000000..80ea5b83
--- /dev/null
+++ b/dev/pkgdown.css
@@ -0,0 +1,384 @@
+/* Sticky footer */
+
+/**
+ * Basic idea: https://philipwalton.github.io/solved-by-flexbox/demos/sticky-footer/
+ * Details: https://github.com/philipwalton/solved-by-flexbox/blob/master/assets/css/components/site.css
+ *
+ * .Site -> body > .container
+ * .Site-content -> body > .container .row
+ * .footer -> footer
+ *
+ * Key idea seems to be to ensure that .container and __all its parents__
+ * have height set to 100%
+ *
+ */
+
+html, body {
+ height: 100%;
+}
+
+body {
+ position: relative;
+}
+
+body > .container {
+ display: flex;
+ height: 100%;
+ flex-direction: column;
+}
+
+body > .container .row {
+ flex: 1 0 auto;
+}
+
+footer {
+ margin-top: 45px;
+ padding: 35px 0 36px;
+ border-top: 1px solid #e5e5e5;
+ color: #666;
+ display: flex;
+ flex-shrink: 0;
+}
+footer p {
+ margin-bottom: 0;
+}
+footer div {
+ flex: 1;
+}
+footer .pkgdown {
+ text-align: right;
+}
+footer p {
+ margin-bottom: 0;
+}
+
+img.icon {
+ float: right;
+}
+
+/* Ensure in-page images don't run outside their container */
+.contents img {
+ max-width: 100%;
+ height: auto;
+}
+
+/* Fix bug in bootstrap (only seen in firefox) */
+summary {
+ display: list-item;
+}
+
+/* Typographic tweaking ---------------------------------*/
+
+.contents .page-header {
+ margin-top: calc(-60px + 1em);
+}
+
+dd {
+ margin-left: 3em;
+}
+
+/* Section anchors ---------------------------------*/
+
+a.anchor {
+ display: none;
+ margin-left: 5px;
+ width: 20px;
+ height: 20px;
+
+ background-image: url(./link.svg);
+ background-repeat: no-repeat;
+ background-size: 20px 20px;
+ background-position: center center;
+}
+
+h1:hover .anchor,
+h2:hover .anchor,
+h3:hover .anchor,
+h4:hover .anchor,
+h5:hover .anchor,
+h6:hover .anchor {
+ display: inline-block;
+}
+
+/* Fixes for fixed navbar --------------------------*/
+
+.contents h1, .contents h2, .contents h3, .contents h4 {
+ padding-top: 60px;
+ margin-top: -40px;
+}
+
+/* Navbar submenu --------------------------*/
+
+.dropdown-submenu {
+ position: relative;
+}
+
+.dropdown-submenu>.dropdown-menu {
+ top: 0;
+ left: 100%;
+ margin-top: -6px;
+ margin-left: -1px;
+ border-radius: 0 6px 6px 6px;
+}
+
+.dropdown-submenu:hover>.dropdown-menu {
+ display: block;
+}
+
+.dropdown-submenu>a:after {
+ display: block;
+ content: " ";
+ float: right;
+ width: 0;
+ height: 0;
+ border-color: transparent;
+ border-style: solid;
+ border-width: 5px 0 5px 5px;
+ border-left-color: #cccccc;
+ margin-top: 5px;
+ margin-right: -10px;
+}
+
+.dropdown-submenu:hover>a:after {
+ border-left-color: #ffffff;
+}
+
+.dropdown-submenu.pull-left {
+ float: none;
+}
+
+.dropdown-submenu.pull-left>.dropdown-menu {
+ left: -100%;
+ margin-left: 10px;
+ border-radius: 6px 0 6px 6px;
+}
+
+/* Sidebar --------------------------*/
+
+#pkgdown-sidebar {
+ margin-top: 30px;
+ position: -webkit-sticky;
+ position: sticky;
+ top: 70px;
+}
+
+#pkgdown-sidebar h2 {
+ font-size: 1.5em;
+ margin-top: 1em;
+}
+
+#pkgdown-sidebar h2:first-child {
+ margin-top: 0;
+}
+
+#pkgdown-sidebar .list-unstyled li {
+ margin-bottom: 0.5em;
+}
+
+/* bootstrap-toc tweaks ------------------------------------------------------*/
+
+/* All levels of nav */
+
+nav[data-toggle='toc'] .nav > li > a {
+ padding: 4px 20px 4px 6px;
+ font-size: 1.5rem;
+ font-weight: 400;
+ color: inherit;
+}
+
+nav[data-toggle='toc'] .nav > li > a:hover,
+nav[data-toggle='toc'] .nav > li > a:focus {
+ padding-left: 5px;
+ color: inherit;
+ border-left: 1px solid #878787;
+}
+
+nav[data-toggle='toc'] .nav > .active > a,
+nav[data-toggle='toc'] .nav > .active:hover > a,
+nav[data-toggle='toc'] .nav > .active:focus > a {
+ padding-left: 5px;
+ font-size: 1.5rem;
+ font-weight: 400;
+ color: inherit;
+ border-left: 2px solid #878787;
+}
+
+/* Nav: second level (shown on .active) */
+
+nav[data-toggle='toc'] .nav .nav {
+ display: none; /* Hide by default, but at >768px, show it */
+ padding-bottom: 10px;
+}
+
+nav[data-toggle='toc'] .nav .nav > li > a {
+ padding-left: 16px;
+ font-size: 1.35rem;
+}
+
+nav[data-toggle='toc'] .nav .nav > li > a:hover,
+nav[data-toggle='toc'] .nav .nav > li > a:focus {
+ padding-left: 15px;
+}
+
+nav[data-toggle='toc'] .nav .nav > .active > a,
+nav[data-toggle='toc'] .nav .nav > .active:hover > a,
+nav[data-toggle='toc'] .nav .nav > .active:focus > a {
+ padding-left: 15px;
+ font-weight: 500;
+ font-size: 1.35rem;
+}
+
+/* orcid ------------------------------------------------------------------- */
+
+.orcid {
+ font-size: 16px;
+ color: #A6CE39;
+ /* margins are required by official ORCID trademark and display guidelines */
+ margin-left:4px;
+ margin-right:4px;
+ vertical-align: middle;
+}
+
+/* Reference index & topics ----------------------------------------------- */
+
+.ref-index th {font-weight: normal;}
+
+.ref-index td {vertical-align: top; min-width: 100px}
+.ref-index .icon {width: 40px;}
+.ref-index .alias {width: 40%;}
+.ref-index-icons .alias {width: calc(40% - 40px);}
+.ref-index .title {width: 60%;}
+
+.ref-arguments th {text-align: right; padding-right: 10px;}
+.ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px}
+.ref-arguments .name {width: 20%;}
+.ref-arguments .desc {width: 80%;}
+
+/* Nice scrolling for wide elements --------------------------------------- */
+
+table {
+ display: block;
+ overflow: auto;
+}
+
+/* Syntax highlighting ---------------------------------------------------- */
+
+pre, code, pre code {
+ background-color: #f8f8f8;
+ color: #333;
+}
+pre, pre code {
+ white-space: pre-wrap;
+ word-break: break-all;
+ overflow-wrap: break-word;
+}
+
+pre {
+ border: 1px solid #eee;
+}
+
+pre .img, pre .r-plt {
+ margin: 5px 0;
+}
+
+pre .img img, pre .r-plt img {
+ background-color: #fff;
+}
+
+code a, pre a {
+ color: #375f84;
+}
+
+a.sourceLine:hover {
+ text-decoration: none;
+}
+
+.fl {color: #1514b5;}
+.fu {color: #000000;} /* function */
+.ch,.st {color: #036a07;} /* string */
+.kw {color: #264D66;} /* keyword */
+.co {color: #888888;} /* comment */
+
+.error {font-weight: bolder;}
+.warning {font-weight: bolder;}
+
+/* Clipboard --------------------------*/
+
+.hasCopyButton {
+ position: relative;
+}
+
+.btn-copy-ex {
+ position: absolute;
+ right: 0;
+ top: 0;
+ visibility: hidden;
+}
+
+.hasCopyButton:hover button.btn-copy-ex {
+ visibility: visible;
+}
+
+/* headroom.js ------------------------ */
+
+.headroom {
+ will-change: transform;
+ transition: transform 200ms linear;
+}
+.headroom--pinned {
+ transform: translateY(0%);
+}
+.headroom--unpinned {
+ transform: translateY(-100%);
+}
+
+/* mark.js ----------------------------*/
+
+mark {
+ background-color: rgba(255, 255, 51, 0.5);
+ border-bottom: 2px solid rgba(255, 153, 51, 0.3);
+ padding: 1px;
+}
+
+/* vertical spacing after htmlwidgets */
+.html-widget {
+ margin-bottom: 10px;
+}
+
+/* fontawesome ------------------------ */
+
+.fab {
+ font-family: "Font Awesome 5 Brands" !important;
+}
+
+/* don't display links in code chunks when printing */
+/* source: https://stackoverflow.com/a/10781533 */
+@media print {
+ code a:link:after, code a:visited:after {
+ content: "";
+ }
+}
+
+/* Section anchors ---------------------------------
+ Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71
+*/
+
+div.csl-bib-body { }
+div.csl-entry {
+ clear: both;
+}
+.hanging-indent div.csl-entry {
+ margin-left:2em;
+ text-indent:-2em;
+}
+div.csl-left-margin {
+ min-width:2em;
+ float:left;
+}
+div.csl-right-inline {
+ margin-left:2em;
+ padding-left:1em;
+}
+div.csl-indent {
+ margin-left: 2em;
+}
diff --git a/dev/pkgdown.js b/dev/pkgdown.js
new file mode 100644
index 00000000..6f0eee40
--- /dev/null
+++ b/dev/pkgdown.js
@@ -0,0 +1,108 @@
+/* http://gregfranko.com/blog/jquery-best-practices/ */
+(function($) {
+ $(function() {
+
+ $('.navbar-fixed-top').headroom();
+
+ $('body').css('padding-top', $('.navbar').height() + 10);
+ $(window).resize(function(){
+ $('body').css('padding-top', $('.navbar').height() + 10);
+ });
+
+ $('[data-toggle="tooltip"]').tooltip();
+
+ var cur_path = paths(location.pathname);
+ var links = $("#navbar ul li a");
+ var max_length = -1;
+ var pos = -1;
+ for (var i = 0; i < links.length; i++) {
+ if (links[i].getAttribute("href") === "#")
+ continue;
+ // Ignore external links
+ if (links[i].host !== location.host)
+ continue;
+
+ var nav_path = paths(links[i].pathname);
+
+ var length = prefix_length(nav_path, cur_path);
+ if (length > max_length) {
+ max_length = length;
+ pos = i;
+ }
+ }
+
+ // Add class to parent
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dev/link.svg b/dev/link.svg
new file mode 100644
index 00000000..88ad8276
--- /dev/null
+++ b/dev/link.svg
@@ -0,0 +1,12 @@
+
+
+
diff --git a/dev/news/index.html b/dev/news/index.html
new file mode 100644
index 00000000..21abe950
--- /dev/null
+++ b/dev/news/index.html
@@ -0,0 +1,574 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ++ + +Read data from an Antares study with R package ‘antaresRead’
+
+
+
+
+
+
+Installation +
+You can install the package from CRAN:
+
+install.packages("antaresRead")You can also install the last development version from Github:
+
+devtools::install_github("rte-antares-rpackage/antaresRead")To display the help of the package and see all the functions it provides, type:
+
+help(package="antaresRead")To see a practical example of use of the package, look at the vignette :
+
+vignette("antares")Finally, you can download a cheatsheet that summarize in a single page how to use the package: https://github.com/rte-antares-rpackage/antaresRead/raw/master/cheat_sheet/antares_cheat_sheet_en.pdf .
+See website for more documentation: https://rte-antares-rpackage.github.io/antaresRead/
+
+
+
+Initialisation +
+Load the package
+ +Select an Antares simulation interactively.
+ +You can also select it programmatically:
+
+setsimulationPath("study_path", simulation)The parameter simulation can be the name of a simulation, the name of the folder containing the simulation results, or the index of the simulation. 1 corresponds to the oldest simulation, -1 to the newest one, 0 to the inputs.
+
+
+
+Read data from a simulation +
+Most data from a simulation can be imported in the R session with function readAntares(). It has many parameters that control what data is imported. Here are a few examples:
+# Read synthetic results of all areas of a study with hourly time step.
+areaData <- readAntares(areas = "all")
+
+# Same but with a daily time step:
+areaData <- readAntares(areas = "all", timeStep = "daily")
+
+# Read all Monte Carlo scenarios for a given area.
+myArea <- readAntares(areas = "my_area", mcYears = "all")
+
+# Same but add miscelaneous production time series to the result
+myArea <- readAntares(areas = "my_area", mcYears = "all", misc = TRUE)
+
+# Read only columns "LOAD" and "MRG. PRICE"
+areaData <- readAntares(areas = "all", select = c("LOAD", "MRG. PRICE"))Functions getAreas and getLinks are helpful to create a selection of areas or links of interest. Here are a few examples:
+# select areas containing "fr"
+myareas <- getAreas("fr")
+
+# Same but remove areas containing "hvdc"
+myareas <- getAreas("fr", exclude = "hvdc")
+
+# Get the links that connect two of the previous areas
+mylinks <- getLinks(myareas, internalOnly = FALSE)
+
+# Get the results for these areas and links
+mydata <- readAntares(areas = myareas, links = mylinks)
+
+
+
+Work with the imported data +
+When only one type of elements is imported (only areas or only links, etc.) readAntares() read antares returns a data.table with some extra attributes. A data.table is a table with some enhanced capacities offered by package data.table. In particular it provides a special syntax to manipulate its content:
+name_of_the_table[filter_rows, select_columns, group_by]Here are some examples:
+
+# Select lines based on some criteria
+mydata[area == "fr" & month == "JUL"]
+
+# Select columns, and compute new ones
+mydata[, .(area, month, load2 = LOAD^2)]
+
+# Aggregate data by some variables
+mydata[, .(total = sum(LOAD)), by = .(month)]
+
+# All three operations can be done with a single line of code
+mydata[area == "fr", .(total = sum(LOAD)), by = .(month)]
+
+help(package = "data.table")If you are not familiar with package data.table, you should have a look at the documentation and especially at the vignettes of the package:
+
+Contributing: +
+Contributions to the library are welcome and can be submitted in the form of pull requests to this repository.
+The folder test_case contains a test Antares study used to run automatic tests. If you modifies it, you need to run the following command to include the modifications in the tests:
+ +
+
+ANTARES : +
+Antares is a powerful software developed by RTE to simulate and study electric power systems (more information about Antares here : https://antares-simulator.org/).
+ANTARES is now an open-source project (since 2018), you can download the sources here if you want to use this package.
+
+
+License Information: +
+Copyright 2015-2016 RTE (France)
+-
+
- RTE: https://www.rte-france.com + +
This Source Code is subject to the terms of the GNU General Public License, version 2 or any higher version. If a copy of the GPL-v2 was not distributed with this file, You can obtain one at https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dev/pkgdown.css b/dev/pkgdown.css
new file mode 100644
index 00000000..80ea5b83
--- /dev/null
+++ b/dev/pkgdown.css
@@ -0,0 +1,384 @@
+/* Sticky footer */
+
+/**
+ * Basic idea: https://philipwalton.github.io/solved-by-flexbox/demos/sticky-footer/
+ * Details: https://github.com/philipwalton/solved-by-flexbox/blob/master/assets/css/components/site.css
+ *
+ * .Site -> body > .container
+ * .Site-content -> body > .container .row
+ * .footer -> footer
+ *
+ * Key idea seems to be to ensure that .container and __all its parents__
+ * have height set to 100%
+ *
+ */
+
+html, body {
+ height: 100%;
+}
+
+body {
+ position: relative;
+}
+
+body > .container {
+ display: flex;
+ height: 100%;
+ flex-direction: column;
+}
+
+body > .container .row {
+ flex: 1 0 auto;
+}
+
+footer {
+ margin-top: 45px;
+ padding: 35px 0 36px;
+ border-top: 1px solid #e5e5e5;
+ color: #666;
+ display: flex;
+ flex-shrink: 0;
+}
+footer p {
+ margin-bottom: 0;
+}
+footer div {
+ flex: 1;
+}
+footer .pkgdown {
+ text-align: right;
+}
+footer p {
+ margin-bottom: 0;
+}
+
+img.icon {
+ float: right;
+}
+
+/* Ensure in-page images don't run outside their container */
+.contents img {
+ max-width: 100%;
+ height: auto;
+}
+
+/* Fix bug in bootstrap (only seen in firefox) */
+summary {
+ display: list-item;
+}
+
+/* Typographic tweaking ---------------------------------*/
+
+.contents .page-header {
+ margin-top: calc(-60px + 1em);
+}
+
+dd {
+ margin-left: 3em;
+}
+
+/* Section anchors ---------------------------------*/
+
+a.anchor {
+ display: none;
+ margin-left: 5px;
+ width: 20px;
+ height: 20px;
+
+ background-image: url(./link.svg);
+ background-repeat: no-repeat;
+ background-size: 20px 20px;
+ background-position: center center;
+}
+
+h1:hover .anchor,
+h2:hover .anchor,
+h3:hover .anchor,
+h4:hover .anchor,
+h5:hover .anchor,
+h6:hover .anchor {
+ display: inline-block;
+}
+
+/* Fixes for fixed navbar --------------------------*/
+
+.contents h1, .contents h2, .contents h3, .contents h4 {
+ padding-top: 60px;
+ margin-top: -40px;
+}
+
+/* Navbar submenu --------------------------*/
+
+.dropdown-submenu {
+ position: relative;
+}
+
+.dropdown-submenu>.dropdown-menu {
+ top: 0;
+ left: 100%;
+ margin-top: -6px;
+ margin-left: -1px;
+ border-radius: 0 6px 6px 6px;
+}
+
+.dropdown-submenu:hover>.dropdown-menu {
+ display: block;
+}
+
+.dropdown-submenu>a:after {
+ display: block;
+ content: " ";
+ float: right;
+ width: 0;
+ height: 0;
+ border-color: transparent;
+ border-style: solid;
+ border-width: 5px 0 5px 5px;
+ border-left-color: #cccccc;
+ margin-top: 5px;
+ margin-right: -10px;
+}
+
+.dropdown-submenu:hover>a:after {
+ border-left-color: #ffffff;
+}
+
+.dropdown-submenu.pull-left {
+ float: none;
+}
+
+.dropdown-submenu.pull-left>.dropdown-menu {
+ left: -100%;
+ margin-left: 10px;
+ border-radius: 6px 0 6px 6px;
+}
+
+/* Sidebar --------------------------*/
+
+#pkgdown-sidebar {
+ margin-top: 30px;
+ position: -webkit-sticky;
+ position: sticky;
+ top: 70px;
+}
+
+#pkgdown-sidebar h2 {
+ font-size: 1.5em;
+ margin-top: 1em;
+}
+
+#pkgdown-sidebar h2:first-child {
+ margin-top: 0;
+}
+
+#pkgdown-sidebar .list-unstyled li {
+ margin-bottom: 0.5em;
+}
+
+/* bootstrap-toc tweaks ------------------------------------------------------*/
+
+/* All levels of nav */
+
+nav[data-toggle='toc'] .nav > li > a {
+ padding: 4px 20px 4px 6px;
+ font-size: 1.5rem;
+ font-weight: 400;
+ color: inherit;
+}
+
+nav[data-toggle='toc'] .nav > li > a:hover,
+nav[data-toggle='toc'] .nav > li > a:focus {
+ padding-left: 5px;
+ color: inherit;
+ border-left: 1px solid #878787;
+}
+
+nav[data-toggle='toc'] .nav > .active > a,
+nav[data-toggle='toc'] .nav > .active:hover > a,
+nav[data-toggle='toc'] .nav > .active:focus > a {
+ padding-left: 5px;
+ font-size: 1.5rem;
+ font-weight: 400;
+ color: inherit;
+ border-left: 2px solid #878787;
+}
+
+/* Nav: second level (shown on .active) */
+
+nav[data-toggle='toc'] .nav .nav {
+ display: none; /* Hide by default, but at >768px, show it */
+ padding-bottom: 10px;
+}
+
+nav[data-toggle='toc'] .nav .nav > li > a {
+ padding-left: 16px;
+ font-size: 1.35rem;
+}
+
+nav[data-toggle='toc'] .nav .nav > li > a:hover,
+nav[data-toggle='toc'] .nav .nav > li > a:focus {
+ padding-left: 15px;
+}
+
+nav[data-toggle='toc'] .nav .nav > .active > a,
+nav[data-toggle='toc'] .nav .nav > .active:hover > a,
+nav[data-toggle='toc'] .nav .nav > .active:focus > a {
+ padding-left: 15px;
+ font-weight: 500;
+ font-size: 1.35rem;
+}
+
+/* orcid ------------------------------------------------------------------- */
+
+.orcid {
+ font-size: 16px;
+ color: #A6CE39;
+ /* margins are required by official ORCID trademark and display guidelines */
+ margin-left:4px;
+ margin-right:4px;
+ vertical-align: middle;
+}
+
+/* Reference index & topics ----------------------------------------------- */
+
+.ref-index th {font-weight: normal;}
+
+.ref-index td {vertical-align: top; min-width: 100px}
+.ref-index .icon {width: 40px;}
+.ref-index .alias {width: 40%;}
+.ref-index-icons .alias {width: calc(40% - 40px);}
+.ref-index .title {width: 60%;}
+
+.ref-arguments th {text-align: right; padding-right: 10px;}
+.ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px}
+.ref-arguments .name {width: 20%;}
+.ref-arguments .desc {width: 80%;}
+
+/* Nice scrolling for wide elements --------------------------------------- */
+
+table {
+ display: block;
+ overflow: auto;
+}
+
+/* Syntax highlighting ---------------------------------------------------- */
+
+pre, code, pre code {
+ background-color: #f8f8f8;
+ color: #333;
+}
+pre, pre code {
+ white-space: pre-wrap;
+ word-break: break-all;
+ overflow-wrap: break-word;
+}
+
+pre {
+ border: 1px solid #eee;
+}
+
+pre .img, pre .r-plt {
+ margin: 5px 0;
+}
+
+pre .img img, pre .r-plt img {
+ background-color: #fff;
+}
+
+code a, pre a {
+ color: #375f84;
+}
+
+a.sourceLine:hover {
+ text-decoration: none;
+}
+
+.fl {color: #1514b5;}
+.fu {color: #000000;} /* function */
+.ch,.st {color: #036a07;} /* string */
+.kw {color: #264D66;} /* keyword */
+.co {color: #888888;} /* comment */
+
+.error {font-weight: bolder;}
+.warning {font-weight: bolder;}
+
+/* Clipboard --------------------------*/
+
+.hasCopyButton {
+ position: relative;
+}
+
+.btn-copy-ex {
+ position: absolute;
+ right: 0;
+ top: 0;
+ visibility: hidden;
+}
+
+.hasCopyButton:hover button.btn-copy-ex {
+ visibility: visible;
+}
+
+/* headroom.js ------------------------ */
+
+.headroom {
+ will-change: transform;
+ transition: transform 200ms linear;
+}
+.headroom--pinned {
+ transform: translateY(0%);
+}
+.headroom--unpinned {
+ transform: translateY(-100%);
+}
+
+/* mark.js ----------------------------*/
+
+mark {
+ background-color: rgba(255, 255, 51, 0.5);
+ border-bottom: 2px solid rgba(255, 153, 51, 0.3);
+ padding: 1px;
+}
+
+/* vertical spacing after htmlwidgets */
+.html-widget {
+ margin-bottom: 10px;
+}
+
+/* fontawesome ------------------------ */
+
+.fab {
+ font-family: "Font Awesome 5 Brands" !important;
+}
+
+/* don't display links in code chunks when printing */
+/* source: https://stackoverflow.com/a/10781533 */
+@media print {
+ code a:link:after, code a:visited:after {
+ content: "";
+ }
+}
+
+/* Section anchors ---------------------------------
+ Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71
+*/
+
+div.csl-bib-body { }
+div.csl-entry {
+ clear: both;
+}
+.hanging-indent div.csl-entry {
+ margin-left:2em;
+ text-indent:-2em;
+}
+div.csl-left-margin {
+ min-width:2em;
+ float:left;
+}
+div.csl-right-inline {
+ margin-left:2em;
+ padding-left:1em;
+}
+div.csl-indent {
+ margin-left: 2em;
+}
diff --git a/dev/pkgdown.js b/dev/pkgdown.js
new file mode 100644
index 00000000..6f0eee40
--- /dev/null
+++ b/dev/pkgdown.js
@@ -0,0 +1,108 @@
+/* http://gregfranko.com/blog/jquery-best-practices/ */
+(function($) {
+ $(function() {
+
+ $('.navbar-fixed-top').headroom();
+
+ $('body').css('padding-top', $('.navbar').height() + 10);
+ $(window).resize(function(){
+ $('body').css('padding-top', $('.navbar').height() + 10);
+ });
+
+ $('[data-toggle="tooltip"]').tooltip();
+
+ var cur_path = paths(location.pathname);
+ var links = $("#navbar ul li a");
+ var max_length = -1;
+ var pos = -1;
+ for (var i = 0; i < links.length; i++) {
+ if (links[i].getAttribute("href") === "#")
+ continue;
+ // Ignore external links
+ if (links[i].host !== location.host)
+ continue;
+
+ var nav_path = paths(links[i].pathname);
+
+ var length = prefix_length(nav_path, cur_path);
+ if (length > max_length) {
+ max_length = length;
+ pos = i;
+ }
+ }
+
+ // Add class to parent
+
+
+
+
+
+
+
+
+
+
+
+ Changelog
+ Source:NEWS.md
+
+
+ antaresRead 2.7.2.9000
+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
+
+
+ antaresRead 2.7.12024-08-30
+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 parameterbinding(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 withthermalDataparameter
+ -
+
setSimulationPath()has also the parameter areasWithSTClusters in ‘output’ mode
+
+
+ antaresRead 2.7.02024-05-28
+
+
+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
lifecycleto manage functions status/package status
+
+
+ antaresRead 2.6.2
+BUGFIXES : * readIniFile() : avoid utils::type.convert on specific cases (ex : 789e or 123i) * api_get() add encoding argument to pass to httr::content()
+
+ antaresRead 2.6.12024-04-22
+BUGFIXES :
+-
+
setSimulationPathAPI(): +- returns an API exception if the requested study ID is incorrect +
-
+
simulationthe 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
+ -
+
readInputThermal()default value when no time series in the selected clusters.
+ -
+
readInputRES()default value when no time series in the selected clusters
+ -
+
readClusterDesc()/readClusterRESDesc()/readClusterSTDesc()return empty dataTable and warning if no cluster in Antares study.
+
+
+ antaresRead 2.6.02023-08-30
+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) +
+ - “short-term storage”
-
+
setSimulationPath()has new parameter areasWithSTClusters (name of area with “st-storage” cluster)
+
BUGFIXES :
+-
+
setSimulationPathAPIgenerate new global parametersleepto add timer to API request
+ - Correction of
.importOutput()to usereadAntares()withparallel == TRUEin 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 filegeneraldatafor sections “playlist” and “variables selection”
+
DATA :
+- A test study in tar.gz format is available in version
v8.6.0+
+
+
+ antaresRead 2.5.12023-04-06
+BUGFIXES:
+- Major correction to
setSimulationPath()(mc-all/mc-ind) (#199)
+
DEV:
+- Added new test study v8.5. +
- Package no longer tested on study v6. +
+
+ antaresRead 2.5.02023-03-13
+NEW FEATURES:
+- Full support of studies up to v8.5 +
- Function
readAntares()has new argument for binding constraints output (v8.4+) (#173)
+ - New functions
readDigestFile(),mergeDigests()andwriteDigest()to manipulate digest file.
+ - Mc-all aggregation :
+
- added computation of record years +
- merges original
digest.txtwith the one created
+ - loads original
thermal.txt+
+
+
BUGFIXES:
+- Major corrections to mc-all and mc-ind aggregation (LOLP, H. LEV) +
- Fixed existing write digest.txt part in mc-all aggregation +
- Fixed copy of original links in mc-all aggregation +
+
+ antaresRead 2.4.22023-02-14
+NEW FEATURES:
+- New function
getGeographicTrimming()returns filtering options for selected areas (links optional).
+ - New function
readInputRes()for reading renewable clusters input data
+ - Existing function
getLinks()now has a new argument withTransmission. if TRUE, return additional column with type of transmission capacities.
+ - Existing function
readInputThermal(): added new argument for thermalData
+
+
+ antaresRead 2.4.1
+NEW FEATURES:
+Added new functions readInputThermal() and readAntaresClusters() : Both functions take a vector of clusters instead of areas * readInputThermal() : read thermal TS (availabilities) and modulation in Input mode * readAntaresClusters() : read output data for clusters only with thematic trimming
+
+ antaresRead 2.4.0
+NEW FEATURES:
+Major upgrade to aggregateResult() and parAggregateMCall() : * Faster & memory efficient * Support for Antares studies up to v8.3 (v8.4 experimental) * Dynamic timestep detection * Creation of grid folder * Recycling of original mc-all data
+
+
+ antaresRead 2.3.2
+NEW FEATURES:
+added “profit by cluster” when reading cluster data.
+BUGFIXES:
+Fix for 404 error when some output is missing in API mode(#188).
+
+
+ antaresRead 2.3.02022-10-10
+- Interact directly with AntaREST API with
api_get(),api_post(),api_put(),api_delete().
+ - New function to read ini files :
readIni().
+
+
+
+ antaresRead 2.2.97
+FEATURES:
+- NTC by monte carlo years, antares 8.2 update
+
- Update readInputTS when linkCapacity argument is used +
- New link inputs +
+
+
+ antaresRead 2.2.952022-03-01
+BUGFIXES:
+- removeVirtualAreas : setting custom prodVars same as new storageVars +
- API : fix study checking + httr options +
+
+
+ antaresRead 2.2.92021-11-06
+FEATURES:
+- Add ENR Cluster support (V8.1) +
- removeVirtualAreas : Can pass storageFlexibility named list +
- removeVirtualAreas : add prodVars, costsVars and costsOn arguments +
- fix linCapacity aggregation +
BUGFIXES:
+- aggregateResult parallel export (#161) +
+
+ antaresRead 2.2.72021-06-08
+FEATURES:
+- Fixed bugs in
readInputTS()forhydroStorage+
+ - New
hvdcModification()function
+ - Add MC Weight functionnality +
- First antares api support +
+
+
+
+
+
+ antaresRead 2.2.52020-03-18
+FEATURES:
+- Fixed bugs in
removeVirtualAreas()ingetLinks()+
+ - Updated documentation & added pkgdown website +
+
+ antaresRead 2.2.0 (2018-09-28)2018-09-28
+BREAKING CHANGES:
+- “removeVirtualAres()” : as a new logical parameter rowBal, if is TRUE (default) then BALANCE will be corrected by ROW. BAL (#antaresProcessing33) +
NEW FEATURES:
+- “removeVirtualAres()” : now correct BALANCE, COST and production of disticts.(#119) +
BUGFIXES:
+- “readLayout()” : prevent bug reading multiple studies +
- “readAntares()” : prevent bug dealing with integer64 +
- “writeAntaresH5()” was not working anymore due to a new version of rhdf5 (h5close() does not work anymore). (#110) +
+
+
+ antaresRead 2.1.2 (2018-06-01)2018-06-04
+BUGFIXES:
+- getLinks() was sending an error when there are no links in the study. +
+
+ antaresRead 2.1.0 (2018-02-23)2018-02-23
+NEW FEATURES:
+- readInputTS() has a new parameter “thermalOutages” that permits to read thermal outages characteristics +
- Call removeVirtualAreas several times in writeAntaresH5() +
BUGFIXES:
+- Correction of some bugs in removeVirtualAreas when there is several virtual nodes of production and storageFlexibility +
- Correction of some bugs due to the new lubridate version +
+
+ antaresRead 2.0.2 (2017-11-21)2017-11-21
+BUGFIXES:
+- Some tests failed in some platforms on CRAN. +
+
+ antaresRead 2.0.1 (2017-11-14)2017-11-14
+BUGFIXES:
+- readLayout() was not taking a list of simOptions. +
+
+ antaresRead 2.0.0 (2017-11-03)2017-11-06
+NEW FEATURES:
+- New function “writeAntaresH5()” convert ANTARES outputs to h5 files. +
- The path parameter of “setSimulationPath()” can be a h5 file. +
- New function “isH5Opts()” test if the value returned by setSimulationPath() is referring to an h5 file. +
- New function “readOptimCriteria()” read the value of the criteria optimized by ANTARES. +
- New function “setRam()” specify RAM limit (in Go) of the value returned by readAntares, initially it is 10Go. +
- New vignette “antaresH5” is available. +
BUGFIXES:
+- removeVirtualAreas() was not moving clusters from virtual production area to the real area. +
- antaresRead() sometimes returned a antaresDataList with element “thermalModulation”. (#51) +
+
+ antaresRead 1.1.4 (2017-07-07)2017-07-11
+BUGFIXES:
+- setSimulation() was crashing with antares v6.0 because of the folder “maps”. (#49) +
+
+ antaresRead 1.1.3 (2017-05-30)2017-05-30
+BUGFIXES:
+- readInputTS was crashing when trying to import cluster data and some clusters were disabled. +
+
+ antaresRead 1.1.2 (2017-04-18)2017-04-20
+BUGFIXES:
+- Fixed an issue that caused compilation to crash on mac OS X +
+
+ antaresRead 1.1.0 (2017-03-31)
+NEW FEATURES:
+- The ‘select’ parameter of readAntares() has been improved. It now accepts new keywords “areas”, “links”, “clusters”, “districts” to indicate which type of data to read,“mcYears” to import detailed results, “misc”, “mustRun”, etc. to import the corresponding input data. +
- A new function setAlias() has been added. It permits to packages developers to define new aliases to use in the ‘select’ parameter of readAntares() in order to help their users to import the required data. +
- readBindingConstraints() has been improved and returns an object of class ‘bindingConstraints’ which is a named list where each element has the same structure. +
- A summary method has been added for objects of class ‘bindingConstraints’. It is useful to quickly look at the binding contraints defined in a study. +
- readAntares(mustRun = TRUE) now adds a new column “thermalPmin”. It is similar to mustRunTotal, except it also takes into account the minimum stable power of the cluster units. +
BUGFIXES:
+- Columns ‘pumpingCapacity’ and ‘storageCapacity’ created by removeVirtualAreas() were reversed. +
- setSimulationPath() was sometimes setting a start data that was not consistent with parameters “1st january” and “leap year”. +
- setSimulationPath() was not working if synthetic results and the first Monte-Carlo scenario were not saved in a given Antares simulation. +
- readAntares(clusters = “all”) was not working in some situations. +
+
+ antaresRead 1.0.0 (2017-02-23)
+BUGFIXES:
+- In some specific situations, date columns could be filled with NA values. (#26) +
- Many small problems that were detected by R CMD CHECK. +
+
+ antaresRead 0.15 (2017-01-25)
+BREAKING CHANGES:
+- Parameter “synthesis” has been removed from readAntares. The new behavior is now to import synthetic results when “mcYears” is NULL and to import detailed results when “mcYears” is set. +
NEW FEATURES:
+- New function “getIdCols()” returns the Id columns of an antaresDataTable object. +
- New method “subset()” for antaresDataList objects permits to quickly extract the data for a given area or a given Monte-Carlo scenario. +
BUGFIXES:
+- In “input” mode, getLinks() could return links that did not exist anymore. +
- removeVirtualAreas was requiring some data that was not necesary. It should be OK now. +
- setSimulationPath() was crashing when one wanted to read the input data of a study before having run any simulation. +
- Variable “timeId” is now always numeric. Before it was numeric except for annual data where it could be character or factor. +
+
+ antaresRead 0.14 (2016-11-14)
+NEW FEATURES:
+- readAntares() has been significantly improved. Depending on the query, the time needed to import data is decreased by 20% up to 95%. In particular, importing data for clusters is now 20 times faster than before. Moreover, the progress bar is now more precise. +
- removeVirtualAreas() has a new parameter “newCols” that permits to choose whether to create new columns containing the production of the virtual areas or to update the existing ones. +
- removeVirtualAreas() now also removes virtual links from the data. Before it was removing virtual areas but keeping the virtual links. +
- If the transmission capacity of the links is present in the data, removeVirtualAreas() now creates two new columns containing the capacity of pumping and storage of areas. These columns are used to compute upward and downward margins. +
- New functions as.antaresDataTable and as.antaresDataList have been added to convert compatible objects to these classes. +
+
+ antaresRead 0.13 (2016-10-06)
+BREAKING CHANGES:
+- add a file LICENSE and copyright to sources files +
+
+ antaresRead 0.12 (2016-08-17)
+BREAKING CHANGES:
+- The object returned by ‘setSimulationPath’ and ‘simOptions’ has been modified. In particular, paths have been renamed to make their utility clearer. Moreover a new element named ‘linksDef’ contains a table with the specification of each link of the study. +
NEW FEATURES:
+- getLinks() can now return a table with the specification of the links, thanks to two new parameters “namesOnly” and “withDirection” +
- It is now possible to import several times the same Monte-Carlo scenario. This can be useful for performance test or to use bootstrap methods. +
BUGFIXES:
+- readClusterDesc was not working in input mode. +
- Sometimes setSimulationPath changed working directory. +
- Solved some performance issues in readAntares() and removeVirtualAreas(). +
+
+ antaresRead 0.11 (2016-08-01)
+BREAKING CHANGES:
+- The parameters of ‘getLinks’ have been modified because they were unclear. Now user has to to explicitly specify areas to include and/or exclude. +
BUGFIXES:
+- setSimulationPath was crashing if parameter ‘horizon’ was not set in Antares. +
- changeTimeStep sometimes generated NA values because of integer overflow. +
+
+ antaresRead 0.10 (2016-07-18)
+BREAKING CHANGES: * Variable mustRunModuction has been renamed minGenModulation for consistency with Antares * Similarly in the object returned by setSimulationPath and simOptions, “setList” has been renamed “districtList”
+NEW FEATURES: * Now, when one filters, add, remove or update columns of an object of class ‘antaresDataTable’, the result is still of class ‘antaresDataTable’.
+
+
+ antaresRead 0.9.1 (2016-07-05)
+BUGFIXES:
+- readAntares was incorrectly setting attributes of its ouput. This resulted in errors when using functions of the antaresProcessing package. +
+
+ antaresRead 0.9 (2016-07-04)
+BREAKING CHANGES:
+- The columns returned by readAntares when ‘hydroStorageMaxPower = TRUE’ have been renamed. +
NEW FEATURES:
+- readAntares has a new parameter “thermalModulation” to import modulation time series. +
- New aliases have been added. One can inspect them with “showAliases()”. +
+
+ antaresRead 0.8 (2016-06-20)
+NEW FEATURES:
+- setSimulationPath nows reads costs of unsupplied et spilled energy. +
- ReadLayout computes coordinates for districts and link between them. +
- getAreas has a new parameter “district” to get areas in a set of districts. +
- getLinks has new parameter “areas” to get links connected to a set of areas. +
BUGFIXES:
+- Small bug fixes that avoid useless warning messages/ +
+
+ antaresRead 0.7 (2016-06-07)
+BREAKING CHANGES:
+- The package has been renamed “antaresRead”. +
NEW FEATURES:
+- changeTimeStep accepts two new functions : min and max. +
- readAntares now computes the number of available units. +
BUGFIXES:
+- setSimulationPath was crashing if parameter “horizon” was not set in Antares. +
- setSimulationPath throws a warning when two simulations have same name and it uses the most recent one. +
- In presence of hubs and production nodes, removeVirtualAreas treated production nodes two times. +
- Column “month” was sometimes numeric and other times character. +
- setSimulationPath was not recognising option “apply-filter = add-all” when retrieving district definition. +
+
+ antaresRead 0.6 (2016-05-27)
+NEW FEATURES:
+- readAntares and readInputTS always add time columns (time, day, month, hour). changeTimeStep now keeps them if they are present. +
BUGFIXES:
+- readAntares may not work when some MC years were not exported by Antares. +
- The construction of the weeks was wrong when a year did not start on january. +
- The import of inputs was wrong when the study was not conducted on a whole year but on a smaller period. +
- In removeVirtualNodes, option “reassignCosts” was not working correctly. +
+
+ antaresRead 0.5 (2016-05-11)
+BREAKING CHANGES:
+- To be consistent with Antares, ‘node’ has been replaced by ‘area’ everywhere in the package. +
- Column ‘MWh’ is now named ‘production’ when reading clusters output. +
NEW FEATURES:
+- new function ‘readInputTS’ to read input time series (without output time series) +
- ‘setSimulationPath’ now accepts two new values for the argument “simulation”: 0 and “input”. These values indicate that the user is not interested by the results of any simulation and only wants to read input data. +
- changeTimeStep now accepts for parameter ‘fun’ a vector of function names that indicate how to aggregate/disagregate each column. +
- getAreas has a new argument “withClustersOnly” to select areas containing clusters +
- readAntares can now also add input time series to districts like it does for areas +
BUGFIXES:
+- ‘copyToClipboard’ was copying the word “txt” instead of copying data +
- ‘removeVirtualNodes’ was not creating some columns for production virtual nodes. +
- The option ‘mustRun’ in readAntares was not functionning correctly +
+
+ antaresRead 0.4 (2016-04-29)
+BREAKING CHANGES:
+- The parameters and the output of “readAntares” have been modified. The output has now only three components: nodes, links and clusters. If the user asks other information like hydro storage or links capacities, they are added to the corresponding component. The corresponding parameters now expect TRUE/ FALSE instead of a vector of node or link names. +
- “getLinks” has now same parameters and behavior than “getNodes” +
- Parameter “trace” has been removed in “setSimulationPath”. +
NEW FEATURES:
+- “readAntares” has a new argument “mustRun” +
- “removeVirtualNodes” has been finalised +
- New function “simOptions” to get either global simulation options or simulation options used by “readAntares” to create a given object +
- New alias “nosum” to remove “min”, “max”, and “std” columns when “synthesis=TRUE” in “readAntares” +
- “setSimulationPath” has a new argument “simulation” to choose a simulation by name or by order inside an antares project +
- New function “getDistricts” +
- New function “copyToClipboard” +
- Added package vignette +
+
+ antaresRead 0.3 (2016-04-14)
+NEW FEATURES:
+- “readAntares” can now read hydro storage, hydro storage maximum power, reserve and links capacity +
- New function “readAntaresNodes”: read all the desired data for a set of nodes +
- New function “readBindingConstraints” +
- New function “changeTimeStep”: change the timestep of an “antaresOutput” object or any table containing a variable timeId +
- New function “getNodes”: select and filter nodes of an antares study +
- “extractDataList” has been improved for better compatibility with PPSE scripts +
- Improved documentation +
- New function removeVirtualNodes (still experimental) +
- Added this NEWS file :) +
+
+ antaresRead 0.2 (2016-04-05)
+BREAKING CHANGES:
+- “readOutput” has been renamed “readAntares” +
NEW FEATURES:
+- “readAntares” can now read thermal availabilities +
- “setSimulationPath” now reads simulation parameters +
- “setSimulationPath” now accepts path to a study and eventually asks the user to choose an output +
- Nodes and sets are now separated in “readAntares” and “setSimulationPath” +
- aliases for groups of variables in parameter “select” of “readAntares” +
![[Experimental]](figures/lifecycle-experimental.svg)
![[Deprecated]](figures/lifecycle-deprecated.svg)