Check + vignette

rte-antares-rpackage · Jun 15, 2017 · 16d5af8 · 16d5af8
1 parent 1e92f1e
commit 16d5af8
Show file tree

Hide file tree

Showing 10 changed files with 68 additions and 12 deletions.
diff --git a/R/benders.R b/R/benders.R
@@ -366,7 +366,7 @@ benders <- function(path_solver, display = TRUE, report = TRUE, clean = TRUE, pa
     }
     if(current_it$cut_type == "weekly")
     {
-      update_weekly_cuts(current_it, candidates, output_area_w, output_link_w, output_link_h, inv_cost, tmp_folder, exp_options, opts)
+      update_weekly_cuts(current_it, candidates, output_area_w, output_link_w, output_link_h, inv_cost, tmp_folder, exp_options)
     }
 
 

diff --git a/R/benders_tools.R b/R/benders_tools.R
@@ -235,7 +235,7 @@ update_yearly_cuts <- function(current_it,candidates, output_area_y,output_link_
 #' @return nothing
 #' 
 #' 
-update_weekly_cuts <- function(current_it, candidates, output_area_w, output_link_w, output_link_h, inv_cost, tmp_folder, benders_options, opts)
+update_weekly_cuts <- function(current_it, candidates, output_area_w, output_link_w, output_link_h, inv_cost, tmp_folder, benders_options)
 {
 
   # compute a few intermediate variables

diff --git a/man/benders.Rd b/man/benders.Rd
diff --git a/man/run_simulation.Rd b/man/run_simulation.Rd
diff --git a/man/set_antares_options.Rd b/man/set_antares_options.Rd
diff --git a/man/update_average_cuts.Rd b/man/update_average_cuts.Rd
diff --git a/man/update_weekly_cuts.Rd b/man/update_weekly_cuts.Rd
diff --git a/man/update_yearly_cuts.Rd b/man/update_yearly_cuts.Rd
diff --git a/man/with_profile.Rd b/man/with_profile.Rd
diff --git a/vignettes/read_me.Rmd b/vignettes/read_me.Rmd
@@ -8,6 +8,8 @@ vignette: >
   %\VignetteEngine{knitr::rmarkdown}
   %\VignetteEncoding{UTF-8}
 ---
+
+
 # antares-rpackageXpansion
 
 
@@ -76,6 +78,21 @@ max-units = 4
 For the case of distributed generation and storage, the investment variables can be *continuous*, without steps of several MW. In that case, the properties `unit-size`and `max-units`can be replaced by the property `max-investment`, and the invested capacity will be able to take any real value between `0` and `max-investment` (in MW).
 
 
+### Capacity profile
+By default, the investment candidates offer a "perfect capacity". That is to say, when 1 MW is invested, this 1 MW will be fully available for all the hours of the year. However, by adding the property `link-profile`, one can define a time series (with an hourly time step) of the ratio between the invested capacity and the capacity which is actually available at a given hour. This feature can be used to model investments in (e.g.) intermittent generation or thermal generation with seasonalized maintenance shutdowns.
+
+The property `link-profile `can be used as below :
+
+```txt
+[1]
+name = solar_power
+link = area1 - pv1
+annual-cost-per-mw = 100000
+max-investment = 10000
+link-profile = pv1.txt
+```
+Where `pv1.txt` is a text file, located in the `user/expansion/capa/` folder of the study, and which contains the load factor time series of the candidate (one column of 8760 values between 0 and 1). When x MW of the candidate solar_power will be invested, the actual time series of available power will be equal to the product of x and the time series `pv1.txt`.
+
 ## Method and settings
 
 ### Benders decomposition
@@ -93,7 +110,7 @@ Concretely, the package will run ANTARES iteratively. Depending on the number of
 
 ### Settings
 
-The different settings can be modified by the user of the package. All the settings are saved in a file `settings.ini` located in the foler `user/expansion/`. 
+The different settings can be modified by the user of the package. All the settings are saved in a file `settings.ini` located in the folder `user/expansion/`. 
 
   * `optimality_gap`: The optimality gap can take any numeric value. The optimality gap is theoretically the maximum possible distance (in euros) between the solution returned by the method and the optimal solution. 
 
@@ -109,7 +126,7 @@ uc_type = relaxed_fast
 master = integer
 optimality_gap = 0
 ```
-Note that the optimality gap can also be given relatively to be best found solution by entering a `%` after the numeric value of the setting. 
+Note that the optimality gap can also be given relatively to be best found solution by entering a `%` after the numeric value of the setting. In that case, the optimality is between `0%`and `100%` and the decimal separator is a point (`.`).
 
 
 ### Which settings should I use for my expansion problem ?
@@ -149,7 +166,7 @@ library(antaresXpansion)
 Select an ANTARES study using [antaresRead package](https://github.com/rte-antares-rpackage/antares-rpackageRead). As no  outputs are needed, the simulation argument should be put to zero.
 
 ```r
-setsimulationPath("study_path", simulation = 0)
+setSimulationPath("study_path", simulation = 0)
 ```
 
 Create the `candidate.ini` and `settings.ini` files as explained above and store them in the directory `study_path/user/expansion`.
-Original file line number
+Diff line change
@@ Expand Up @@
         }
         if(current_it$cut_type == "weekly")
         {
-          update_weekly_cuts(current_it, candidates, output_area_w, output_link_w, output_link_h, inv_cost, tmp_folder, exp_options, opts)
+          update_weekly_cuts(current_it, candidates, output_area_w, output_link_w, output_link_h, inv_cost, tmp_folder, exp_options)
         }
@@ Expand Down @@