diff --git a/R/createCluster.R b/R/createCluster.R index 6deb3998..bd3bf854 100644 --- a/R/createCluster.R +++ b/R/createCluster.R @@ -117,7 +117,7 @@ #' area = "fr", #' cluster_name = "my_cluster", #' prepro_data = data.frame( -#' v1 = rep(7, 365), # column name doesn't matter +#' v1 = rep(7, 365), # column name does not matter #' v2 = rep(27, 365), #' v3 = rep(0.05, 365), #' v4 = rep(0.12, 365), @@ -132,7 +132,7 @@ #' createCluster( #' area = "fr", #' cluster_name = "my_cluster", -#' prepro_modulation = = matrix( +#' prepro_modulation = matrix( #' data = c(rep(1, times = 365 * 24 * 3), #' rep(0, times = 365 * 24 * 1)), #' ncol = 4 @@ -144,7 +144,7 @@ #' area = "fr", #' cluster_name = "my_cluster", #' prepro_modulation = data.frame( -#' var1 = rep(0, 8760), # column name doesn't matter +#' var1 = rep(0, 8760), # column name does not matter #' var2 = rep(1, 8760), #' var3 = rep(0, 8760), #' var4 = rep(1, 8760) diff --git a/R/updateOutputSettings.R b/R/updateOutputSettings.R index ec4acd39..98538edf 100644 --- a/R/updateOutputSettings.R +++ b/R/updateOutputSettings.R @@ -25,7 +25,7 @@ #' updateOutputSettings( #' synthesis = TRUE, #' storenewset = FALSE, -#' archives = c("load", "wind") +#' archives = c("load", "wind"), #' result.format = "zip" #' ) #' diff --git a/docs/404.html b/docs/404.html index f9125c81..be5ad2ab 100644 --- a/docs/404.html +++ b/docs/404.html @@ -32,7 +32,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index 23e48566..b471633d 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/articles/Antares_new_features_v860.html b/docs/articles/Antares_new_features_v860.html index 13be0475..0bd27e47 100644 --- a/docs/articles/Antares_new_features_v860.html +++ b/docs/articles/Antares_new_features_v860.html @@ -33,7 +33,7 @@ antaresEditObject - 0.6.0 + 0.6.1 @@ -102,7 +102,9 @@

Antares new features v8.6.0

-library(antaresEditObject)
+ # CRAN limite CPU usage
+data.table::setDTthreads(2)
+library(antaresEditObject)
 #> Loading required package: antaresRead
 #> 
 #> Attaching package: 'antaresEditObject'
diff --git a/docs/articles/antaresEditObject.html b/docs/articles/antaresEditObject.html
index 1ed36138..05d4a2a7 100644
--- a/docs/articles/antaresEditObject.html
+++ b/docs/articles/antaresEditObject.html
@@ -33,7 +33,7 @@
       
       
         antaresEditObject
-        0.6.0
+        0.6.1
@@ -105,7 +105,9 @@

Prerequisites
-library(antaresEditObject)
+ # CRAN limite CPU usage +data.table::setDTthreads(2) +library(antaresEditObject)

You need to set the path to an Antares study in “input” mode:

 antaresRead::setSimulationPath(path = "path/to/study", simulation = "input")
@@ -263,6 +265,87 @@

Run an Antares simulation path_solver = "C:/path/to/antares-solver.exe", show_output_on_console = TRUE ) + +
+

Read a time series, update it and write it +

+

To update an existing time series and write it, you can use the following commands :

+
+# Filepath of the study, version >= 820
+my_study <- file.path("", "", "")
+opts <- setSimulationPath(my_study, simulation ="input")
+opts$timeIdMax <- 8760
+
+# Links, use only one link
+my_link <- as.character(getLinks()[1])
+ts_input <- readInputTS(linkCapacity = my_link, opts = opts)
+
+# Sort the data to ensure its reliability
+data.table::setorder(ts_input, cols = "tsId", "timeId") 
+
+# Reshape to wide format : writeInputTS expects a 8760 * N matrix 
+metrics <- c("transCapacityDirect", "transCapacityIndirect")
+ts_input_reformatted <- data.table::dcast(ts_input,
+                                          timeId ~ tsId,
+                                          value.var = metrics
+                                          )
+# Add a value my_param to your matrix
+my_param <- 123
+writeInputTS(data = ts_input_reformatted[,2:ncol(ts_input_reformatted)] + my_param,
+             type = "tsLink",
+             link = my_link,
+             overwrite = TRUE,
+             opts = opts
+             )
+
+
+# Thermal, use only one area and one cluster
+my_area <- "zone"
+my_cluster <- "mon_cluster"
+ts_input <- readInputTS(thermalAvailabilities = my_area, opts = opts)
+ts_input <- ts_input[cluster == paste0(my_area,"_",my_cluster)]
+
+# Sort the data to ensure its reliability
+data.table::setorder(ts_input, cols = "tsId", "timeId")
+
+# Reshape to wide format : writeInputTS expects a 8760 * N matrix 
+metrics <- c("ThermalAvailabilities")
+ts_input_reformatted <- data.table::dcast(ts_input,
+                                          timeId ~ tsId,
+                                          value.var = metrics
+                                          )
+
+# Add a value my_param to your matrix
+my_param <- 1000
+editCluster(area = my_area,
+            cluster_name = my_cluster,
+            time_series = ts_input_reformatted[,2:ncol(ts_input_reformatted)] + my_param,
+            opts = opts
+            )
+
+
+# Run of River, use only one area
+my_area <- "zone"
+ts_input <- readInputTS(ror = my_area, opts = opts)
+
+# Sort the data to ensure its reliability
+data.table::setorder(ts_input, cols = "tsId", "timeId")
+
+# Reshape to wide format : writeInputTS expects a 8760 * N matrix 
+metrics <- c("ror")
+ts_input_reformatted <- data.table::dcast(ts_input,
+                                          timeId ~ tsId,
+                                          value.var = metrics
+)
+
+# Add a value my_param to your matrix
+my_param <- 1000
+writeInputTS(area = my_area,
+            type = "hydroROR",
+            data = ts_input_reformatted[,2:ncol(ts_input_reformatted)] + my_param,
+            overwrite = TRUE,
+            opts = opts
+)
diff --git a/docs/articles/api-variant-management.html b/docs/articles/api-variant-management.html index 4c898dad..c2e12198 100644 --- a/docs/articles/api-variant-management.html +++ b/docs/articles/api-variant-management.html @@ -33,7 +33,7 @@ antaresEditObject - 0.6.0 + 0.6.1 @@ -101,7 +101,9 @@

Variant management with API

-library(antaresEditObject)
+ # CRAN limite CPU usage
+data.table::setDTthreads(2)
+library(antaresEditObject)
 #> Loading required package: antaresRead
 #> 
 #> Attaching package: 'antaresEditObject'
@@ -588,7 +590,7 @@ 
Scenario builder#>     "action": "update_config",
 #>     "args": {
 #>       "target": "settings/scenariobuilder/Default Ruleset",
-#>       "data": {"l,area01,0":1,"l,area01,1":2,"l,area01,2":3,"l,area01,3":1,"l,area01,4":2,"l,area01,5":3} [truncated]...
+#>       "data": []
 #>     }
 #>   }
 #> ]
diff --git a/docs/articles/index.html b/docs/articles/index.html index 99f581d0..ef811abb 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/articles/renewables-energy-sources.html b/docs/articles/renewables-energy-sources.html index c9e2eeaf..86eb378d 100644 --- a/docs/articles/renewables-energy-sources.html +++ b/docs/articles/renewables-energy-sources.html @@ -33,7 +33,7 @@ antaresEditObject - 0.6.0 + 0.6.1 @@ -101,7 +101,9 @@

Renewables Energy Sources

+ # CRAN limite CPU usage +data.table::setDTthreads(2) +library(antaresEditObject)

Antares v8.0.3 allow to work with renewable energy sources, implemented in Antares as a new functionnality: renewables clusters. Here’s a quick start guide to use those new features.

As always, setup the study you want to use:

diff --git a/docs/articles/scenario-builder.html b/docs/articles/scenario-builder.html
index d0ea52b3..d3b1453e 100644
--- a/docs/articles/scenario-builder.html
+++ b/docs/articles/scenario-builder.html
@@ -33,7 +33,7 @@
       
       
         antaresEditObject
-        0.6.0
+        0.6.1
@@ -101,7 +101,9 @@

Scenario Builder

-library(antaresEditObject)
+ # CRAN limite CPU usage
+data.table::setDTthreads(2)
+library(antaresEditObject)
 #> Loading required package: antaresRead
 #> 
 #> Attaching package: 'antaresEditObject'
@@ -237,29 +239,19 @@ 
Scenario Builder

 )
 
 readScenarioBuilder()$t
-#>                  [,1] [,2] [,3] [,4] [,5] [,6] [,7] [,8] [,9] [,10]
-#> earth_africa        2    3    1    2    3    1    2    3    1     2
-#> earth_america       2    3    1    2    3    1    2    3    1     2
-#> earth_europe        2    3    1    2    3    1    2    3    1     2
-#> moon_serenety       3    1    2    3    1    2    3    1    2     3
-#> moon_tranquility    3    1    2    3    1    2    3    1    2     3
+#> NULL

We can specify specific clusters with:

 updateScenarioBuilder(
   ldata = my_scenario, 
   series = "thermal",
-  clusters_areas = data.table::data.table(
+  clusters_areas = data.table::data.table(
     area = c("earth", "earth"),
     cluster = c("africa", "europe")
   )
 )
 readScenarioBuilder()$t
-#>                  [,1] [,2] [,3] [,4] [,5] [,6] [,7] [,8] [,9] [,10]
-#> earth_africa        2    3    1    2    3    1    2    3    1     2
-#> earth_america      NA   NA   NA   NA   NA   NA   NA   NA   NA    NA
-#> earth_europe        2    3    1    2    3    1    2    3    1     2
-#> moon_serenety      NA   NA   NA   NA   NA   NA   NA   NA   NA    NA
-#> moon_tranquility   NA   NA   NA   NA   NA   NA   NA   NA   NA    NA
+#> NULL

For NTC serie (Antares >= 8.2.0), it writes the scenario for all links :

 updateScenarioBuilder(
diff --git a/docs/authors.html b/docs/authors.html
index 33f0b4c4..89865d03 100644
--- a/docs/authors.html
+++ b/docs/authors.html
@@ -17,7 +17,7 @@
       
       
         antaresEditObject
-        0.6.0
+        0.6.1
@@ -133,13 +133,13 @@

Citation

Vargas T, Breant F, Perrier V (2023). antaresEditObject: Edit an 'Antares' Simulation. -R package version 0.6.0, https://github.com/rte-antares-rpackage/antaresEditObject. +R package version 0.6.1, https://github.com/rte-antares-rpackage/antaresEditObject. 

@Manual{,
   title = {antaresEditObject: Edit an 'Antares' Simulation},
   author = {Tatiana Vargas and Frederic Breant and Victor Perrier},
   year = {2023},
-  note = {R package version 0.6.0},
+  note = {R package version 0.6.1},
   url = {https://github.com/rte-antares-rpackage/antaresEditObject},
 }
diff --git a/docs/index.html b/docs/index.html index b662f1c1..da6cfcfc 100644 --- a/docs/index.html +++ b/docs/index.html @@ -35,7 +35,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/news/index.html b/docs/news/index.html index bcf19122..bd97514c 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 @@ -69,6 +69,13 @@

Changelog

Source: NEWS.md +
+

antaresEditObject 0.6.1

+
+

Breaking changes

+
  • +writeInputTS() allows the user to set a link with the separator ’ - ’ (ex: ‘area1 - area2’)
+

antaresEditObject 0.6.0

@@ -91,9 +98,19 @@

Breaking c
  • Add and edit the property enable-first-step in adequacy patch section in settings/generaldata.ini

    • NEW FEATURES :

    -

    Breaking changes

    @@ -110,6 +127,8 @@

    Breaking changesremoveLink() delete properly data for an Antares version >= 820
  • rollback_to_previous_data() enable to rollback if original value is NULL
    • +
  • +writeInputTS() allows the user to set a link with the separator ’ - ’ (ex: ‘area1 - area2’)

    • BUGFIXES :

    • api_command_execute() add timer to request api
      • diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index b15d22e8..c19ffa9f 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -7,5 +7,5 @@ articles: api-variant-management: api-variant-management.html renewables-energy-sources: renewables-energy-sources.html scenario-builder: scenario-builder.html -last_built: 2023-09-19T13:55Z +last_built: 2023-12-06T09:29Z diff --git a/docs/reference/activateRES.html b/docs/reference/activateRES.html index 0849f039..dc7b6db6 100644 --- a/docs/reference/activateRES.html +++ b/docs/reference/activateRES.html @@ -19,7 +19,7 @@ antaresEditObject - 0.6.0 + 0.6.1

    diff --git a/docs/reference/activateST.html b/docs/reference/activateST.html index c61a17c5..e35735c8 100644 --- a/docs/reference/activateST.html +++ b/docs/reference/activateST.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1
    diff --git a/docs/reference/add_week_number_column_to_ts.html b/docs/reference/add_week_number_column_to_ts.html index c707a8b7..5a204036 100644 --- a/docs/reference/add_week_number_column_to_ts.html +++ b/docs/reference/add_week_number_column_to_ts.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/adequacyOptions.html b/docs/reference/adequacyOptions.html index 4d0a051a..0b5044ea 100644 --- a/docs/reference/adequacyOptions.html +++ b/docs/reference/adequacyOptions.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/antaresRead-reexports.html b/docs/reference/antaresRead-reexports.html index 5a27ed59..e043724f 100644 --- a/docs/reference/antaresRead-reexports.html +++ b/docs/reference/antaresRead-reexports.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/backupStudy.html b/docs/reference/backupStudy.html index 0eefba77..788468fe 100644 --- a/docs/reference/backupStudy.html +++ b/docs/reference/backupStudy.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/check-version.html b/docs/reference/check-version.html index eeebc390..87863864 100644 --- a/docs/reference/check-version.html +++ b/docs/reference/check-version.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/checkRemovedArea.html b/docs/reference/checkRemovedArea.html index 5fc345e9..4de9da49 100644 --- a/docs/reference/checkRemovedArea.html +++ b/docs/reference/checkRemovedArea.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/check_consistency_reservoir_values.html b/docs/reference/check_consistency_reservoir_values.html index 8476c0ce..8f1d5f9d 100644 --- a/docs/reference/check_consistency_reservoir_values.html +++ b/docs/reference/check_consistency_reservoir_values.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/check_mingen_vs_hydro_storage.html b/docs/reference/check_mingen_vs_hydro_storage.html index f8d69ea7..8c0bf0d0 100644 --- a/docs/reference/check_mingen_vs_hydro_storage.html +++ b/docs/reference/check_mingen_vs_hydro_storage.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/check_mingen_vs_maxpower.html b/docs/reference/check_mingen_vs_maxpower.html index 198cd9b9..2d525bb8 100644 --- a/docs/reference/check_mingen_vs_maxpower.html +++ b/docs/reference/check_mingen_vs_maxpower.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/cleanUpOutput.html b/docs/reference/cleanUpOutput.html index 0eb10181..675dd3a0 100644 --- a/docs/reference/cleanUpOutput.html +++ b/docs/reference/cleanUpOutput.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/computeOtherFromHourlyMulti.html b/docs/reference/computeOtherFromHourlyMulti.html index ddf96b41..5500baa3 100644 --- a/docs/reference/computeOtherFromHourlyMulti.html +++ b/docs/reference/computeOtherFromHourlyMulti.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/computeOtherFromHourlyYear.html b/docs/reference/computeOtherFromHourlyYear.html index b08ece70..ec6387a7 100644 --- a/docs/reference/computeOtherFromHourlyYear.html +++ b/docs/reference/computeOtherFromHourlyYear.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/computeTimeStampFromHourly.html b/docs/reference/computeTimeStampFromHourly.html index 9fe34267..2b3e626f 100644 --- a/docs/reference/computeTimeStampFromHourly.html +++ b/docs/reference/computeTimeStampFromHourly.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/convertConfigToAdq.html b/docs/reference/convertConfigToAdq.html index dff59b83..cf8549a2 100644 --- a/docs/reference/convertConfigToAdq.html +++ b/docs/reference/convertConfigToAdq.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/copyOutput.html b/docs/reference/copyOutput.html index 0e8c984e..a2b9b78f 100644 --- a/docs/reference/copyOutput.html +++ b/docs/reference/copyOutput.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/copyStudyWeb.html b/docs/reference/copyStudyWeb.html index b796001d..df8bbda2 100644 --- a/docs/reference/copyStudyWeb.html +++ b/docs/reference/copyStudyWeb.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/create-binding-constraint.html b/docs/reference/create-binding-constraint.html index 32996b6a..75302234 100644 --- a/docs/reference/create-binding-constraint.html +++ b/docs/reference/create-binding-constraint.html @@ -19,7 +19,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/create-study.html b/docs/reference/create-study.html index 381ec13b..7a18a60d 100644 --- a/docs/reference/create-study.html +++ b/docs/reference/create-study.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/createArea.html b/docs/reference/createArea.html index 7074ee5a..f4d50c51 100644 --- a/docs/reference/createArea.html +++ b/docs/reference/createArea.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/createCluster.html b/docs/reference/createCluster.html index 1106724b..1969906d 100644 --- a/docs/reference/createCluster.html +++ b/docs/reference/createCluster.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 @@ -175,7 +175,112 @@

    See also

    Examples

    - + 
    if (FALSE) {
+
+library(antaresRead)
+library(antaresEditObject)
+
+# Create a cluster :
+createCluster(
+  area = "fr", 
+  cluster_name = "my_cluster",
+  group = "other", 
+  unitcount = 1L, # or as.integer(1)
+  marginal_cost = 50
+)
+# by default, cluster name is prefixed 
+# by the area name
+levels(readClusterDesc()$cluster)
+# > "fr_my_cluster"
+
+# To prevent this, use `add_prefix`
+createCluster(
+  area = "fr", 
+  cluster_name = "my_cluster",
+  add_prefix = FALSE,
+  group = "other", 
+  marginal_cost = 50
+)
+levels(readClusterDesc()$cluster)
+# > "my_cluster"
+
+
+# Create a RES cluster :
+createClusterRES(
+  area = "fr", 
+  cluster_name = "my_cluster_res",
+  group = "other", 
+  unitcount = 1L, # or as.integer(1)
+  nominalcapacity = 50,
+  ts_interpretation = "power-generation"
+) 
+
+# You can also specify that the Time-Series of the RES cluster are
+# production factors :
+createClusterRES(
+  area = "fr", 
+  cluster_name = "my_cluster_res",
+  group = "other", 
+  unitcount = 1L, # or as.integer(1)
+  nominalcapacity = 50,
+  ts_interpretation = "production-factor"
+)
+
+
+# Pre-process data : 
+
+# this is the default data :
+createCluster(
+  area = "fr", 
+  cluster_name = "my_cluster",
+  prepro_data = matrix(
+    data = c(rep(1, times = 365 * 2),
+             rep(0, times = 365 * 4)), 
+    ncol = 6
+  )
+)
+
+# with a data.frame
+createCluster(
+  area = "fr", 
+  cluster_name = "my_cluster",
+  prepro_data = data.frame(
+    v1 = rep(7, 365), # column name does not matter
+    v2 = rep(27, 365),
+    v3 = rep(0.05, 365),
+    v4 = rep(0.12, 365),
+    v5 = rep(0, 365),
+    v6 = rep(1, 365)
+  )
+)
+
+
+# Pre-process modulation : 
+# this is the default data
+createCluster(
+  area = "fr", 
+  cluster_name = "my_cluster",
+  prepro_modulation = matrix(
+    data = c(rep(1, times = 365 * 24 * 3),
+             rep(0, times = 365 * 24 * 1)),
+    ncol = 4
+  )
+)
+
+# with a data.frame
+createCluster(
+  area = "fr", 
+  cluster_name = "my_cluster",
+  prepro_modulation = data.frame(
+    var1 = rep(0, 8760), # column name does not matter
+    var2 = rep(1, 8760),
+    var3 = rep(0, 8760),
+    var4 = rep(1, 8760)
+  )
+)
+
+}
+
    diff --git a/docs/reference/createClusterST.html b/docs/reference/createClusterST.html index 26291ff8..65c652f2 100644 --- a/docs/reference/createClusterST.html +++ b/docs/reference/createClusterST.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/createDSR.html b/docs/reference/createDSR.html index 168212e0..cfb1a4e3 100644 --- a/docs/reference/createDSR.html +++ b/docs/reference/createDSR.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/createDistrict.html b/docs/reference/createDistrict.html index 2d50e53b..b47e58af 100644 --- a/docs/reference/createDistrict.html +++ b/docs/reference/createDistrict.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/createLink.html b/docs/reference/createLink.html index 4ea4ab27..e8042564 100644 --- a/docs/reference/createLink.html +++ b/docs/reference/createLink.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/createPSP.html b/docs/reference/createPSP.html index dbb2d34b..1be0d776 100644 --- a/docs/reference/createPSP.html +++ b/docs/reference/createPSP.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/create_referential_series_type.html b/docs/reference/create_referential_series_type.html new file mode 100644 index 00000000..d75259a7 --- /dev/null +++ b/docs/reference/create_referential_series_type.html @@ -0,0 +1,111 @@ + +Create the correspondence data frame between the symbol and the type in scenario builder — create_referential_series_type • antaresEditObject + + +
    +
    + + + +
    +
    +
    +

    Create the correspondence data frame between the symbol and the type in scenario builder

    + Source: R/scenarioBuilder.R + +
    + +
    +

    Create the correspondence data frame between the symbol and the type in scenario builder

    +
    + +
    + 
    create_referential_series_type()
    +
    + +
    +

    Value

    + + +

    a data.frame.

    +
    + +
    + +
    + + +
    +

    Developed by Tatiana Vargas, Frederic Breant, Victor Perrier.

    +
    + +
    +

    Site built with pkgdown 2.0.6.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/deleteStudy.html b/docs/reference/deleteStudy.html index 5de40c86..2cd39aec 100644 --- a/docs/reference/deleteStudy.html +++ b/docs/reference/deleteStudy.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/dicoGeneralSettings.html b/docs/reference/dicoGeneralSettings.html index ac32c8da..26608328 100644 --- a/docs/reference/dicoGeneralSettings.html +++ b/docs/reference/dicoGeneralSettings.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/dicoOptimizationSettings.html b/docs/reference/dicoOptimizationSettings.html index 962d22ac..13cfa6a6 100644 --- a/docs/reference/dicoOptimizationSettings.html +++ b/docs/reference/dicoOptimizationSettings.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/dot-dailyToWeekly.html b/docs/reference/dot-dailyToWeekly.html index 572331dc..e01bbeb0 100644 --- a/docs/reference/dot-dailyToWeekly.html +++ b/docs/reference/dot-dailyToWeekly.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/dot-hourlyToOther.html b/docs/reference/dot-hourlyToOther.html index 102dc707..c205e68e 100644 --- a/docs/reference/dot-hourlyToOther.html +++ b/docs/reference/dot-hourlyToOther.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/editArea.html b/docs/reference/editArea.html index 6b19e132..a7c8d7a3 100644 --- a/docs/reference/editArea.html +++ b/docs/reference/editArea.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/editBindingConstraint.html b/docs/reference/editBindingConstraint.html index d6ea3446..37d62c94 100644 --- a/docs/reference/editBindingConstraint.html +++ b/docs/reference/editBindingConstraint.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/editCluster.html b/docs/reference/editCluster.html index 74260602..d4ebac9f 100644 --- a/docs/reference/editCluster.html +++ b/docs/reference/editCluster.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/editClusterST.html b/docs/reference/editClusterST.html index 7b0b802a..dbabc168 100644 --- a/docs/reference/editClusterST.html +++ b/docs/reference/editClusterST.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/editLink.html b/docs/reference/editLink.html index 88f52239..7a96b515 100644 --- a/docs/reference/editLink.html +++ b/docs/reference/editLink.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/fill_empty_hydro_ini_file.html b/docs/reference/fill_empty_hydro_ini_file.html index b8f7c8ef..5a4799b9 100644 --- a/docs/reference/fill_empty_hydro_ini_file.html +++ b/docs/reference/fill_empty_hydro_ini_file.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/fill_empty_hydro_ts_file.html b/docs/reference/fill_empty_hydro_ts_file.html index e480c47a..c38ca925 100644 --- a/docs/reference/fill_empty_hydro_ts_file.html +++ b/docs/reference/fill_empty_hydro_ts_file.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/filteringOptions.html b/docs/reference/filteringOptions.html index 64f33cc7..3074ac0f 100644 --- a/docs/reference/filteringOptions.html +++ b/docs/reference/filteringOptions.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/getJobLogs.html b/docs/reference/getJobLogs.html index 7fd69e5b..7051b538 100644 --- a/docs/reference/getJobLogs.html +++ b/docs/reference/getJobLogs.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/getJobs.html b/docs/reference/getJobs.html index 61d83e80..e7b9b7c8 100644 --- a/docs/reference/getJobs.html +++ b/docs/reference/getJobs.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/get_default_hydro_ini_values.html b/docs/reference/get_default_hydro_ini_values.html index a771b1b3..5041c69d 100644 --- a/docs/reference/get_default_hydro_ini_values.html +++ b/docs/reference/get_default_hydro_ini_values.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/get_type_check_mingen_vs_hydrostorage.html b/docs/reference/get_type_check_mingen_vs_hydrostorage.html index 88a31b2b..4f0a2300 100644 --- a/docs/reference/get_type_check_mingen_vs_hydrostorage.html +++ b/docs/reference/get_type_check_mingen_vs_hydrostorage.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/get_type_check_mingen_vs_hydrostorage_to_trigger.html b/docs/reference/get_type_check_mingen_vs_hydrostorage_to_trigger.html index 8c1ebbdf..6ae097ce 100644 --- a/docs/reference/get_type_check_mingen_vs_hydrostorage_to_trigger.html +++ b/docs/reference/get_type_check_mingen_vs_hydrostorage_to_trigger.html @@ -20,7 +20,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/get_type_check_mingen_vs_maxpower_to_trigger.html b/docs/reference/get_type_check_mingen_vs_maxpower_to_trigger.html index 959a2be5..829b7c31 100644 --- a/docs/reference/get_type_check_mingen_vs_maxpower_to_trigger.html +++ b/docs/reference/get_type_check_mingen_vs_maxpower_to_trigger.html @@ -21,7 +21,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/index.html b/docs/reference/index.html index 96a8aa89..bbe9417f 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 @@ -180,6 +180,10 @@

    All functions createPSP() getCapacityPSP() editPSP()

    Create a Pumped Storage Power plant (PSP)

    + +

    create_referential_series_type()

    + +

    Create the correspondence data frame between the symbol and the type in scenario builder

    deleteStudy()

    diff --git a/docs/reference/list_pollutants_values.html b/docs/reference/list_pollutants_values.html index 9f2eaa37..443359a0 100644 --- a/docs/reference/list_pollutants_values.html +++ b/docs/reference/list_pollutants_values.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/mockSimulationAPI.html b/docs/reference/mockSimulationAPI.html index d7c29cea..27b8f7a3 100644 --- a/docs/reference/mockSimulationAPI.html +++ b/docs/reference/mockSimulationAPI.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/nodalOptimizationOptions.html b/docs/reference/nodalOptimizationOptions.html index acb5f117..fa02ed1c 100644 --- a/docs/reference/nodalOptimizationOptions.html +++ b/docs/reference/nodalOptimizationOptions.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/playlist.html b/docs/reference/playlist.html index 34b9eb36..4cec0e05 100644 --- a/docs/reference/playlist.html +++ b/docs/reference/playlist.html @@ -23,7 +23,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/propertiesLinkOptions.html b/docs/reference/propertiesLinkOptions.html index 029b2a66..4129a913 100644 --- a/docs/reference/propertiesLinkOptions.html +++ b/docs/reference/propertiesLinkOptions.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/removeArea.html b/docs/reference/removeArea.html index 114af32f..e5d1b871 100644 --- a/docs/reference/removeArea.html +++ b/docs/reference/removeArea.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/removeBindingConstraint.html b/docs/reference/removeBindingConstraint.html index b115a2d6..27b23a22 100644 --- a/docs/reference/removeBindingConstraint.html +++ b/docs/reference/removeBindingConstraint.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/removeCluster.html b/docs/reference/removeCluster.html index 2b0e9ae3..3cf19328 100644 --- a/docs/reference/removeCluster.html +++ b/docs/reference/removeCluster.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/removeLink.html b/docs/reference/removeLink.html index 302a8f87..96bb7529 100644 --- a/docs/reference/removeLink.html +++ b/docs/reference/removeLink.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/replicate_missing_ts.html b/docs/reference/replicate_missing_ts.html index 8db2e5b4..a8cadc04 100644 --- a/docs/reference/replicate_missing_ts.html +++ b/docs/reference/replicate_missing_ts.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/rollback_to_previous_data.html b/docs/reference/rollback_to_previous_data.html index 9316c47b..42421f3b 100644 --- a/docs/reference/rollback_to_previous_data.html +++ b/docs/reference/rollback_to_previous_data.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/runSimulation.html b/docs/reference/runSimulation.html index ea78351c..172b242d 100644 --- a/docs/reference/runSimulation.html +++ b/docs/reference/runSimulation.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/runTsGenerator.html b/docs/reference/runTsGenerator.html index b92fb76e..36cbaea5 100644 --- a/docs/reference/runTsGenerator.html +++ b/docs/reference/runTsGenerator.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/scenario-builder.html b/docs/reference/scenario-builder.html index e38ea6ca..562cbd9c 100644 --- a/docs/reference/scenario-builder.html +++ b/docs/reference/scenario-builder.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 @@ -82,6 +82,7 @@

    Read, create, update & deduplicate scenario builder

    n_mc = NULL, areas = NULL, areas_rand = NULL, + coef_hydro_levels = NULL, opts = antaresRead::simOptions() ) @@ -129,6 +130,10 @@

    Arguments

    Areas for which to use "rand".

    +
    coef_hydro_levels
    +

    Hydro levels coefficients.

    + +
    opts

    List of simulation parameters returned by the function antaresRead::setSimulationPath()

    @@ -145,7 +150,7 @@

    Arguments

    ldata

    A matrix obtained with scenarioBuilder, or a named list of matrices obtained with scenarioBuilder, names must be -'l', 'h', 'w', 's', 't', 'r' or 'ntc', depending on the series to update.

    +'l', 'h', 'w', 's', 't', 'r', 'ntc' or 'hl', depending on the series to update.

    series
    @@ -176,7 +181,8 @@

    Value

    Note

    -

    series = "ntc" is only available with Antares >= 8.2.0.

    +

    series = "ntc" is only available with Antares >= 8.2.0. +series = "hl" each value must be between 0 and 1.

    @@ -201,6 +207,21 @@

    Examples

    sbuilder[, 1:6] dim(sbuilder) +# Create a scenario builder matrix for hydro levels (use case 1) +sbuilder <- scenarioBuilder( + n_mc = opts$parameters$general$nbyears, + areas = c("fr", "be"), + coef_hydro_levels = c(0.1, 0.9) +) + +# Create a scenario builder matrix for hydro levels (use case 2) +sbuilder <- scenarioBuilder( + n_mc = opts$parameters$general$nbyears, + areas = c("fr", "be"), + coef_hydro_levels = c(runif(opts$parameters$general$nbyears) + , runif(opts$parameters$general$nbyears) + ) +) # Read previous scenario builder # in a matrix format diff --git a/docs/reference/searchStudy.html b/docs/reference/searchStudy.html index 0db51946..0903393b 100644 --- a/docs/reference/searchStudy.html +++ b/docs/reference/searchStudy.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1
    diff --git a/docs/reference/setAPImode.html b/docs/reference/setAPImode.html index 9f530f25..31ce89dd 100644 --- a/docs/reference/setAPImode.html +++ b/docs/reference/setAPImode.html @@ -21,7 +21,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/setSolverPath.html b/docs/reference/setSolverPath.html index 0acb8f2b..ee205844 100644 --- a/docs/reference/setSolverPath.html +++ b/docs/reference/setSolverPath.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/storage_values_default.html b/docs/reference/storage_values_default.html index 4358be74..85ab5420 100644 --- a/docs/reference/storage_values_default.html +++ b/docs/reference/storage_values_default.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/updateAdequacySettings.html b/docs/reference/updateAdequacySettings.html index 1ccbe1fd..c8081d9d 100644 --- a/docs/reference/updateAdequacySettings.html +++ b/docs/reference/updateAdequacySettings.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/updateGeneralSettings.html b/docs/reference/updateGeneralSettings.html index a1326a73..cc2abe7c 100644 --- a/docs/reference/updateGeneralSettings.html +++ b/docs/reference/updateGeneralSettings.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/updateInputSettings.html b/docs/reference/updateInputSettings.html index e6669b43..dffc0097 100644 --- a/docs/reference/updateInputSettings.html +++ b/docs/reference/updateInputSettings.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/updateOptimizationSettings.html b/docs/reference/updateOptimizationSettings.html index ba98df89..40f7a6af 100644 --- a/docs/reference/updateOptimizationSettings.html +++ b/docs/reference/updateOptimizationSettings.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/updateOutputSettings.html b/docs/reference/updateOutputSettings.html index 8b167422..74f9bb77 100644 --- a/docs/reference/updateOutputSettings.html +++ b/docs/reference/updateOutputSettings.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 @@ -120,7 +120,18 @@

    Value

    Examples

    - + 
    if (FALSE) {
+
+updateOutputSettings(
+  synthesis = TRUE,
+  storenewset = FALSE,
+  archives = c("load", "wind"),
+  result.format = "zip"
+)
+
+}
+
+
    diff --git a/docs/reference/variant.html b/docs/reference/variant.html index 5968cb37..be370b42 100644 --- a/docs/reference/variant.html +++ b/docs/reference/variant.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/write-ini.html b/docs/reference/write-ini.html index a714dd9f..1b6c39c6 100644 --- a/docs/reference/write-ini.html +++ b/docs/reference/write-ini.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/writeEconomicOptions.html b/docs/reference/writeEconomicOptions.html index b2a7c0fd..7cb1d2b1 100644 --- a/docs/reference/writeEconomicOptions.html +++ b/docs/reference/writeEconomicOptions.html @@ -19,7 +19,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/writeHydroValues.html b/docs/reference/writeHydroValues.html index dbea1b30..16661720 100644 --- a/docs/reference/writeHydroValues.html +++ b/docs/reference/writeHydroValues.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/writeIniHydro.html b/docs/reference/writeIniHydro.html index ae9fcb31..ac736c8c 100644 --- a/docs/reference/writeIniHydro.html +++ b/docs/reference/writeIniHydro.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/writeInputTS.html b/docs/reference/writeInputTS.html index 82a3f537..3425efa2 100644 --- a/docs/reference/writeInputTS.html +++ b/docs/reference/writeInputTS.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 @@ -109,7 +109,7 @@

    Arguments

    link

    Link for which writing transmission capacities time series, -must like "area01%area02" or c("area01", "area02").

    +must like "area01%area02" or "area01 - area02" or c("area01", "area02").

    overwrite
    diff --git a/docs/reference/writeMiscGen.html b/docs/reference/writeMiscGen.html index 1673ce51..b684746f 100644 --- a/docs/reference/writeMiscGen.html +++ b/docs/reference/writeMiscGen.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/writeOutputValues.html b/docs/reference/writeOutputValues.html index 31080429..f05cdbcb 100644 --- a/docs/reference/writeOutputValues.html +++ b/docs/reference/writeOutputValues.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/writeSeriesPrepro.html b/docs/reference/writeSeriesPrepro.html index d9da4c64..5257fa63 100644 --- a/docs/reference/writeSeriesPrepro.html +++ b/docs/reference/writeSeriesPrepro.html @@ -19,7 +19,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/reference/writeWaterValues.html b/docs/reference/writeWaterValues.html index 9f0f3a01..b1885c3c 100644 --- a/docs/reference/writeWaterValues.html +++ b/docs/reference/writeWaterValues.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.0 + 0.6.1 diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 7c3b470e..c5800d13 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -117,6 +117,9 @@ /reference/createPSP.html + + /reference/create_referential_series_type.html + /reference/deleteStudy.html diff --git a/man/createCluster.Rd b/man/createCluster.Rd index 96f157b5..4e1e5d0e 100644 --- a/man/createCluster.Rd +++ b/man/createCluster.Rd @@ -148,7 +148,7 @@ createCluster( area = "fr", cluster_name = "my_cluster", prepro_data = data.frame( - v1 = rep(7, 365), # column name doesn't matter + v1 = rep(7, 365), # column name does not matter v2 = rep(27, 365), v3 = rep(0.05, 365), v4 = rep(0.12, 365), @@ -163,7 +163,7 @@ createCluster( createCluster( area = "fr", cluster_name = "my_cluster", - prepro_modulation = = matrix( + prepro_modulation = matrix( data = c(rep(1, times = 365 * 24 * 3), rep(0, times = 365 * 24 * 1)), ncol = 4 @@ -175,7 +175,7 @@ createCluster( area = "fr", cluster_name = "my_cluster", prepro_modulation = data.frame( - var1 = rep(0, 8760), # column name doesn't matter + var1 = rep(0, 8760), # column name does not matter var2 = rep(1, 8760), var3 = rep(0, 8760), var4 = rep(1, 8760) diff --git a/man/updateOutputSettings.Rd b/man/updateOutputSettings.Rd index c46ea915..06d561a7 100644 --- a/man/updateOutputSettings.Rd +++ b/man/updateOutputSettings.Rd @@ -40,7 +40,7 @@ Update output parameters of an Antares study updateOutputSettings( synthesis = TRUE, storenewset = FALSE, - archives = c("load", "wind") + archives = c("load", "wind"), result.format = "zip" )