diff --git a/.Rbuildignore b/.Rbuildignore index e92cac8e..63ee6338 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -4,3 +4,6 @@ ^\.Rproj\.user$ test_case/ ^\.travis\.yml$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 00000000..4691d4e3 --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,5 @@ +destination: docs + +template: + params: + bootswatch: readable diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 00000000..7085e02f --- /dev/null +++ b/docs/404.html @@ -0,0 +1,133 @@ + + + + + + + + +Page not found (404) • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + +
+ +
+
+ + +Content not found. Please use links in the navbar. + +
+ +
+ + + + +
+ + + + + + + + diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html new file mode 100644 index 00000000..10859da6 --- /dev/null +++ b/docs/LICENSE-text.html @@ -0,0 +1,134 @@ + + + + + + + + +License • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + +
+ +
+
+ + +
COPYRIGHT HOLDER: RTE Réseau de transport d’électricité 
+
+ +
+ +
+ + + + +
+ + + + + + + + diff --git a/docs/authors.html b/docs/authors.html new file mode 100644 index 00000000..9b579597 --- /dev/null +++ b/docs/authors.html @@ -0,0 +1,170 @@ + + + + + + + + +Authors • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + +
+ +
+
+ + +
    +
  • +

    Veronique Bachelier. Author, maintainer. +

    +
  • +
  • +

    Frederic Breant. Author. +

    +
  • +
  • +

    Victor Perrier. Author. +

    +
  • +
  • +

    Baptiste Seguinot. Contributor. +

    +
  • +
  • +

    Benoit Thieurmel. Contributor. +

    +
  • +
  • +

    Titouan Robert. Contributor. +

    +
  • +
  • +

    Jalal-Edine Zawam. Contributor. +

    +
  • +
  • +

    Etienne Sanchez. Contributor. +

    +
  • +
  • +

    RTE. Copyright holder. +

    +
  • +
+ +
+ +
+ + + + +
+ + + + + + + + diff --git a/docs/docsearch.css b/docs/docsearch.css new file mode 100644 index 00000000..e5f1fe1d --- /dev/null +++ b/docs/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/docs/docsearch.js b/docs/docsearch.js new file mode 100644 index 00000000..b35504cd --- /dev/null +++ b/docs/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/docs/index.html b/docs/index.html new file mode 100644 index 00000000..f71b4ab6 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,279 @@ + + + + + + + +Edit an Antares Simulation • antaresEditObject + + + + + + + + + + +
+
+ + + + +
+
+ +


+
+ +
+

Edit an Antares study before running simulation. Methods are provided to create (and remove) area, links between them, thermal cluster and binding constraints. These steps maybe usefull before running an Antares simulation.

+
+

Travis-CI Build Status Coverage Status version cran checks Lifecycle: stable Project Status: Active – The project has reached a stable, usable state and is being actively developed. cranlogs

+
+

+Installation

+

Install from CRAN:

+
install.packages("antaresEditObject")
+

Or install dev version from GitHub :

+
remotes::install_github("rte-antares-rpackage/antaresEditObject")
+
+
+

+Prerequisites

+

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

+
antaresRead::setSimulationPath(path = "path/to/study", simulation = "input")
+

Or you can simply create a new study :

+
createStudy("path/to/study")
+
+
+

+Save simulation

+

Before modifying your simulation, you can save it in an archive :

+
backupStudy(what = "input")
+

This will create a .tar.gz file in your simulation folder.

+
+
+

+Create a new area

+

You can create a new area with :

+
library("antaresEditObject")
+
+createArea(name = "myarea")
+
+# The new area should appear here :
+antaresRead::getAreas()
+

You can specify the localization of the area on the map, and also color.

+

There are two helper function for area parameters :

+ +
+ + +
+

+Create a binding constraint

+ +
+
+

+Create several Pumped Storage Power plant (PSP)

+ +
+
+

+Create several Demand Side Response (DSR)

+
dsrData <- data.frame(
+  area = c("a", "b"),
+  unit = c(10,20), 
+  nominalCapacity = c(100, 120),
+  marginalCost = c(52, 65),
+  hour = c(3, 7)
+)
+  
+createDSR(dsrData)
+
+
+

+Update general settings

+

For example, set the output of simulation year by year, and limit the number of Monte-Carlo years to 10 :

+
updateGeneralSettings(year.by.year = TRUE, nbyears = 10)
+
+
+

+Remove methods

+

You can remove from input folder areas, links, clusters and binding constraints with remove* functions, e.g. :

+
removeArea("myarea")
+
+
+

+Run Time-Series Generator

+

First, update general settings to activate time series to generate :

+
updateGeneralSettings(generate = "thermal")
+

Then run TS-generator:

+ +
+ +
+ +
+ + +
+ + + +
+ + + + + + diff --git a/docs/link.svg b/docs/link.svg new file mode 100644 index 00000000..88ad8276 --- /dev/null +++ b/docs/link.svg @@ -0,0 +1,12 @@ + + + + + + diff --git a/docs/news/index.html b/docs/news/index.html new file mode 100644 index 00000000..5db2dd6e --- /dev/null +++ b/docs/news/index.html @@ -0,0 +1,167 @@ + + + + + + + + +Changelog • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + +
+ +
+
+ + +
+

+antaresEditObject 0.1.7 2019-07-18 +

+
    +
  • Fix createPSP to work with Antares v7
  • +
+
+
+

+antaresEditObject 0.1.6 2019-05-13 +

+
    +
  • Compatibility with Antares version 7
  • +
+
+
+

+antaresEditObject 0.1.4 Unreleased +

+
    +
  • Initial release.
  • +
  • Added a NEWS.md file to track changes to the package.
  • +
+
+
+ + + +
+ + + +
+ + + + + + + + diff --git a/docs/pkgdown.css b/docs/pkgdown.css new file mode 100644 index 00000000..91459581 --- /dev/null +++ b/docs/pkgdown.css @@ -0,0 +1,256 @@ +/* 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 > .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; +} + +img { + max-width: 100%; +} + +/* Fix bug in bootstrap (only seen in firefox) */ +summary { + display: list-item; +} + +/* Typographic tweaking ---------------------------------*/ + +.contents .page-header { + margin-top: calc(-60px + 1em); +} + +/* Section anchors ---------------------------------*/ + +a.anchor { + margin-left: -30px; + display:inline-block; + width: 30px; + height: 30px; + visibility: hidden; + + background-image: url(./link.svg); + background-repeat: no-repeat; + background-size: 20px 20px; + background-position: center center; +} + +.hasAnchor:hover a.anchor { + visibility: visible; +} + +@media (max-width: 767px) { + .hasAnchor:hover a.anchor { + visibility: hidden; + } +} + + +/* Fixes for fixed navbar --------------------------*/ + +.contents h1, .contents h2, .contents h3, .contents h4 { + padding-top: 60px; + margin-top: -40px; +} + +/* Sidebar --------------------------*/ + +#sidebar { + margin-top: 30px; + position: -webkit-sticky; + position: sticky; + top: 70px; +} +#sidebar h2 { + font-size: 1.5em; + margin-top: 1em; +} + +#sidebar h2:first-child { + margin-top: 0; +} + +#sidebar .list-unstyled li { + margin-bottom: 0.5em; +} + +.orcid { + height: 16px; + /* 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;} +.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;} +.ref-arguments .name {width: 20%;} +.ref-arguments .desc {width: 80%;} + +/* Nice scrolling for wide elements --------------------------------------- */ + +table { + display: block; + overflow: auto; +} + +/* Syntax highlighting ---------------------------------------------------- */ + +pre { + word-wrap: normal; + word-break: normal; + border: 1px solid #eee; +} + +pre, code { + background-color: #f8f8f8; + color: #333; +} + +pre code { + overflow: auto; + word-wrap: normal; + white-space: pre; +} + +pre .img { + margin: 5px 0; +} + +pre .img img { + background-color: #fff; + display: block; + height: auto; +} + +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 */ + +.message { color: black; font-weight: bolder;} +.error { color: orange; font-weight: bolder;} +.warning { color: #6A0366; 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: ""; + } +} diff --git a/docs/pkgdown.js b/docs/pkgdown.js new file mode 100644 index 00000000..087a7622 --- /dev/null +++ b/docs/pkgdown.js @@ -0,0 +1,113 @@ +/* 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); + }); + + $('body').scrollspy({ + target: '#sidebar', + offset: 60 + }); + + $('[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
  • , and enclosing
  • if in dropdown + if (pos >= 0) { + var menu_anchor = $(links[pos]); + menu_anchor.parent().addClass("active"); + menu_anchor.closest("li.dropdown").addClass("active"); + } + }); + + function paths(pathname) { + var pieces = pathname.split("/"); + pieces.shift(); // always starts with / + + var end = pieces[pieces.length - 1]; + if (end === "index.html" || end === "") + pieces.pop(); + return(pieces); + } + + // Returns -1 if not found + function prefix_length(needle, haystack) { + if (needle.length > haystack.length) + return(-1); + + // Special case for length-0 haystack, since for loop won't run + if (haystack.length === 0) { + return(needle.length === 0 ? 0 : -1); + } + + for (var i = 0; i < haystack.length; i++) { + if (needle[i] != haystack[i]) + return(i); + } + + return(haystack.length); + } + + /* Clipboard --------------------------*/ + + function changeTooltipMessage(element, msg) { + var tooltipOriginalTitle=element.getAttribute('data-original-title'); + element.setAttribute('data-original-title', msg); + $(element).tooltip('show'); + element.setAttribute('data-original-title', tooltipOriginalTitle); + } + + if(ClipboardJS.isSupported()) { + $(document).ready(function() { + var copyButton = ""; + + $(".examples, div.sourceCode").addClass("hasCopyButton"); + + // Insert copy buttons: + $(copyButton).prependTo(".hasCopyButton"); + + // Initialize tooltips: + $('.btn-copy-ex').tooltip({container: 'body'}); + + // Initialize clipboard: + var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', { + text: function(trigger) { + return trigger.parentNode.textContent; + } + }); + + clipboardBtnCopies.on('success', function(e) { + changeTooltipMessage(e.trigger, 'Copied!'); + e.clearSelection(); + }); + + clipboardBtnCopies.on('error', function() { + changeTooltipMessage(e.trigger,'Press Ctrl+C or Command+C to copy'); + }); + }); + } +})(window.jQuery || window.$) diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml new file mode 100644 index 00000000..f0f8cf01 --- /dev/null +++ b/docs/pkgdown.yml @@ -0,0 +1,5 @@ +pandoc: 2.7.2 +pkgdown: 1.4.1 +pkgdown_sha: ~ +articles: [] + diff --git a/docs/reference/backupStudy.html b/docs/reference/backupStudy.html new file mode 100644 index 00000000..fc729d02 --- /dev/null +++ b/docs/reference/backupStudy.html @@ -0,0 +1,180 @@ + + + + + + + + +Create a backup with an Antares Study — backupStudy • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Save an Antares Study or only inputs in a .tar.gz file

    +
    + +
    backupStudy(
    +  backupfile,
    +  what = c("input", "study"),
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + +
    backupfile

    Name of the backup, without extension. If missing, +either the name of the study or 'input' according argument what.

    what

    Which folder to save, input for the input folder +or study for the whole study.

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    The path of the backup

    + +

    Examples

    +
    if (FALSE) { +backupStudy() +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/checkRemovedArea.html b/docs/reference/checkRemovedArea.html new file mode 100644 index 00000000..94e8862a --- /dev/null +++ b/docs/reference/checkRemovedArea.html @@ -0,0 +1,174 @@ + + + + + + + + +Seek for a removed area — checkRemovedArea • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Check if it remains trace of a deleted area in the input folder

    +
    + +
    checkRemovedArea(area, all_files = TRUE, opts = antaresRead::simOptions())
    + +

    Arguments

    + + + + + + + + + + + + + + +
    area

    An area

    all_files

    Check files in study directory.

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    a named list with two elements

    + +

    Examples

    +
    if (FALSE) { +checkRemovedArea("myarea") +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/createArea.html b/docs/reference/createArea.html new file mode 100644 index 00000000..cdacb404 --- /dev/null +++ b/docs/reference/createArea.html @@ -0,0 +1,206 @@ + + + + + + + + +Create An Area In An Antares Study — createArea • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Create An Area In An Antares Study

    +
    + +
    createArea(
    +  name,
    +  color = grDevices::rgb(230, 108, 44, max = 255),
    +  localization = c(0, 0),
    +  nodalOptimization = nodalOptimizationOptions(),
    +  filtering = filteringOptions(),
    +  overwrite = FALSE,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    name

    Name of the area as a character, without punctuation except - and _.

    color

    Color of the node

    localization

    Localization on the map

    nodalOptimization

    Nodal optimization parameters, see nodalOptimizationOptions.

    filtering

    Filtering parameters, see filteringOptions.

    overwrite

    Overwrite the area if already exist.

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    An updated list containing various information about the simulation.

    + +

    Examples

    +
    if (FALSE) { + +library(antaresRead) + +# Set simulation path +setSimulationPath(path = "PATH/TO/SIMULATION", simulation = "input") + +# Create a new area +createArea("fictive_area") + +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/createBindingConstraint.html b/docs/reference/createBindingConstraint.html new file mode 100644 index 00000000..2563351d --- /dev/null +++ b/docs/reference/createBindingConstraint.html @@ -0,0 +1,216 @@ + + + + + + + + +Create a Binding Constraint — createBindingConstraint • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Create a Binding Constraint

    +
    + +
    createBindingConstraint(
    +  name,
    +  id = tolower(name),
    +  values = NULL,
    +  enabled = TRUE,
    +  timeStep = c("hourly", "daily", "weekly"),
    +  operator = c("both", "equal", "greater", "less"),
    +  coefficients = NULL,
    +  overwrite = FALSE,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    name

    The name for the binding constraint

    id

    An id

    values

    Values used by the constraint. +It contains one line per time step and three columns "less", "greater" and "equal".

    enabled

    Logical, is the constraint enabled ?

    timeStep

    Time step the constraint applies to : hourly, daily or weekly

    operator

    Type of constraint: equality, inequality on one side or both sides.

    coefficients

    A named vector containing the coefficients used by the constraint.

    overwrite

    If the constraint already exist, overwrite the previous value.

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    An updated list containing various information about the simulation.

    + +

    Examples

    +
    if (FALSE) { +createBindingConstraint( + name = "myconstraint", + values = matrix(data = rep(0, 8760 * 3), ncol = 3), + enabled = FALSE, + timeStep = "hourly", + operator = "both", + coefficients = c("fr%myarea" = 1) +) +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/createCluster.html b/docs/reference/createCluster.html new file mode 100644 index 00000000..5823af11 --- /dev/null +++ b/docs/reference/createCluster.html @@ -0,0 +1,210 @@ + + + + + + + + +Create a thermal cluster — createCluster • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Create a thermal cluster

    +
    + +
    createCluster(
    +  area,
    +  cluster_name,
    +  ...,
    +  time_series = NULL,
    +  prepro_data = NULL,
    +  prepro_modulation = NULL,
    +  add_prefix = TRUE,
    +  overwrite = FALSE,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    area

    The area where to create the cluster.

    cluster_name

    cluster name.

    ...

    Parameters to write in the Ini file. Careful! +Some parameters must be set as integers to avoid warnings in Antares, for example, +to set unitcount, you'll have to use unitcount = 1L.

    time_series

    the "ready-made" 8760-hour time-series available for simulation purposes.

    prepro_data

    Pre-process data, a data.frame or matrix, +default is a matrix with 365 rows and 6 columns.

    prepro_modulation

    Pre-process modulation, a data.frame or matrix, +if specified, must have 8760 rows and 1 or 4 columns.

    add_prefix

    If TRUE, cluster_name will be prefixed by area name.

    overwrite

    Logical, overwrite the cluster or not.

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    An updated list containing various information about the simulation.

    + +

    Examples

    +
    
    +  
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/createDSR.html b/docs/reference/createDSR.html new file mode 100644 index 00000000..df88591d --- /dev/null +++ b/docs/reference/createDSR.html @@ -0,0 +1,212 @@ + + + + + + + + +Create a Demand Side Response (DSR) — createDSR • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Create a Demand Side Response (DSR)

    +
    + +
    createDSR(
    +  areasAndDSRParam = NULL,
    +  spinning = 2,
    +  overwrite = FALSE,
    +  opts = antaresRead::simOptions()
    +)
    +
    +getCapacityDSR(area = NULL, opts = antaresRead::simOptions())
    +
    +editDSR(
    +  area = NULL,
    +  unit = NULL,
    +  nominalCapacity = NULL,
    +  marginalCost = NULL,
    +  spinning = NULL,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    areasAndDSRParam

    A data.frame with 4 columns area, unit, +nominalCapacity, marginalCost and hour. +Hour represent the number of activation hours for the DSR per day.

    spinning

    DSR spinning

    overwrite

    Overwrite the DSR plant if already exist. +This will overwrite the previous area and links.

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    area

    an area where to edit the DSR

    unit

    DSR unit number

    nominalCapacity

    DSR nominalCapacity

    marginalCost

    DSR marginalCost

    + +

    Value

    + +

    createDSR() and editDSR() returns an updated list containing various information about the simulation.

    +

    getCapacityDSR() returns DSR capacity (unit * nominalCapacity of virtual cluster) of the area

    + +

    Examples

    +
    
    +  
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/createDistrict.html b/docs/reference/createDistrict.html new file mode 100644 index 00000000..a162fd74 --- /dev/null +++ b/docs/reference/createDistrict.html @@ -0,0 +1,211 @@ + + + + + + + + +Create a district — createDistrict • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Allows selecting a set of areas so as to bundle them together in a "district".

    +
    + +
    createDistrict(
    +  name,
    +  caption = NULL,
    +  comments = NULL,
    +  apply_filter = "none",
    +  add_area = NULL,
    +  remove_area = NULL,
    +  output = FALSE,
    +  overwrite = FALSE,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    name

    District's name.

    caption

    Caption for the district.

    comments

    Comments for the district.

    apply_filter

    Possible values are add-all to add all areas to the district, +remove-all to clear the district, or none (default) to don't apply a filter.

    add_area

    Character vector of area(s) to add to the district.

    remove_area

    Character vector of area(s) to remove from the district.

    output

    Logical, compute the results for the district or not?

    overwrite

    Logical, should the district be overwritten if already exist?

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    An updated list containing various information about the simulation.

    + +

    Examples

    +
    if (FALSE) { +createDistrict(name = "mydistrict", + apply_filter = "add-all", + remove_area = c("fr", "be")) +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/createLink.html b/docs/reference/createLink.html new file mode 100644 index 00000000..ee9f1ff3 --- /dev/null +++ b/docs/reference/createLink.html @@ -0,0 +1,229 @@ + + + + + + + + +Create a link between two areas — createLink • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Create a link between two areas

    +
    + +
    createLink(
    +  from,
    +  to,
    +  propertiesLink = propertiesLinkOptions(),
    +  dataLink = NULL,
    +  overwrite = FALSE,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    from

    The first area from which to create a link

    to

    The second one

    propertiesLink

    a named list containing the link properties, e.g. hurdles-cost +or transmission-capacities for example. See propertiesLinkOptions.

    dataLink

    For Antares v7, a matrix with eight column corresponding to : trans. capacity (direct) +trans. capacity (indirect), hurdles cost (direct), hurdles cost (indirect), impedances, loop flow, +PST min, PST max. +If NULL (default), a matrix whose rows are equal to 1, 1, 0, 0, 0, 0, 0, 0 is set. See Details

    overwrite

    Logical, overwrite the previous between the two areas if exist

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    An updated list containing various information about the simulation.

    +

    Details

    + +

    The eight times-series are:

      +
    • NTC direct : the upstream-to-downstream capacity, in MW

    • +
    • NTC indirect : the downstream-to-upstream capacity, in MW

    • +
    • Hurdle cost direct : an upstream-to-downstream transmission fee, in euro/MWh

    • +
    • Hurdle cost indirect : a downstream-to-upstream transmission fee, in euro/MWh

    • +
    • Impedances : virtual impedances that are used in economy simulations to give a + physical meaning to raw outputs, when no binding constraints have been defined to enforce Kirchhoff's laws.

    • +
    • Loop flow : amount of power flowing circularly though the grid when all + “nodes” are perfectly balanced (no import and no export).

    • +
    • PST min : lower bound of phase-shifting that can be reached by a PST installed on the link, if any.

    • +
    • PST max : upper bound of phase-shifting that can be reached by a PST installed on the link, if any.

    • +

    NB: For Antares v7 the eight columns must conform to above order. For Antares v6, only five columns are +expected, and they must follow this other order: NTC direct, NTC indirect, Impedances, Hurdle cost direct, +Hurdle cost indirect.

    +

    Note

    + +

    In Antares, areas are sorted in alphabetical order to establish links between. +For example, link between "fr" and "be" will appear under "be". +So the areas are sorted before creating the link between them, and dataLink is +rearranged to match the new order.

    + +

    Examples

    +
    if (FALSE) { + +library(antaresRead) + +# Set simulation path +setSimulationPath(path = "PATH/TO/SIMULATION", simulation = "input") + +# Create a link between two areas +createLink(from = "first_area", to = "second_area") + +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/createPSP.html b/docs/reference/createPSP.html new file mode 100644 index 00000000..21c45376 --- /dev/null +++ b/docs/reference/createPSP.html @@ -0,0 +1,257 @@ + + + + + + + + +Create a Pumped Storage Power plant (PSP) — createPSP • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Create a Pumped Storage Power plant (PSP)

    +
    + +
    createPSP(
    +  areasAndCapacities = NULL,
    +  namePumping = "Psp_In",
    +  nameTurbining = "Psp_Out",
    +  hurdleCost = 5e-04,
    +  timeStepBindConstraint = "weekly",
    +  efficiency = NULL,
    +  overwrite = FALSE,
    +  opts = antaresRead::simOptions()
    +)
    +
    +getCapacityPSP(
    +  area = NULL,
    +  nameTurbining = "Psp_Out",
    +  timeStepBindConstraint = "weekly",
    +  opts = antaresRead::simOptions()
    +)
    +
    +editPSP(
    +  area = NULL,
    +  capacity = NULL,
    +  namePumping = "Psp_In",
    +  nameTurbining = "Psp_Out",
    +  timeStepBindConstraint = "weekly",
    +  hurdleCost = 5e-04,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    areasAndCapacities

    A data.frame with 2 columns installedCapacity and area

    namePumping

    The name of the pumping area

    nameTurbining

    The name of the turbining area

    hurdleCost

    The cost of the PSP

    timeStepBindConstraint

    Time step for the binding constraint : daily or weekly

    efficiency

    The efficiency of the PSP

    overwrite

    Overwrite the Pumped Storage Power plant if already exist. +This will overwrite the previous area and links.

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    area

    an area name

    capacity

    PSP capacity for the area

    + +

    Value

    + +

    createPSP() and editPSP() returns an updated list containing various information about the simulation.

    +

    getCapacityPSP() returns PSP capacity of the area

    + +

    Examples

    +
    if (FALSE) { + +library(antaresEditObject) +path<-pathToYourStudy +opts<-setSimulationPath(path, simulation = "input") +pspData<-data.frame(area=c("a", "b"), installedCapacity=c(800,900)) + +createPSP(pspData, efficiency = 0.8) + +createPSP(pspData, efficiency = 0.66, overwrite = TRUE) +createPSP(pspData, efficiency = 0.98, timeStepBindConstraint = "daily") +getAreas() + +} + +if (FALSE) { + +getCapacityPSP("a") +editPSP("a", capacity = 8000, hurdleCost = 0.1) +getCapacityPSP("a") + +areaName<-"suisse" +createArea(areaName, overwrite = TRUE) +pspData<-data.frame(area=c(areaName), installedCapacity=c(9856)) +createPSP(pspData, efficiency = 0.5, overwrite = TRUE, timeStepBindConstraint = "daily") + +getCapacityPSP(areaName, timeStepBindConstraint = "daily") + + +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/createStudy.html b/docs/reference/createStudy.html new file mode 100644 index 00000000..42c6087f --- /dev/null +++ b/docs/reference/createStudy.html @@ -0,0 +1,176 @@ + + + + + + + + +Create an empty Antares study — createStudy • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Create an empty Antares study

    +
    + +
    createStudy(path, study_name = "my_study", antares_version = "7.0.0")
    + +

    Arguments

    + + + + + + + + + + + + + + +
    path

    Path where to create study, it should be an empty directory, +if it doesn't exist, it'll be created.

    study_name

    Name of the study.

    antares_version

    Antares number version.

    + +

    Value

    + +

    logical vector indicating success or failure

    + +

    Examples

    +
    if (FALSE) { + +createStudy("path/to/simulation") + +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/dicoGeneralSettings.html b/docs/reference/dicoGeneralSettings.html new file mode 100644 index 00000000..daadcf63 --- /dev/null +++ b/docs/reference/dicoGeneralSettings.html @@ -0,0 +1,163 @@ + + + + + + + + +Correspondence between arguments of <code>updateGeneralSettings</code> and actual Antares parameters. — dicoGeneralSettings • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Correspondence between arguments of updateGeneralSettings and actual Antares parameters.

    +
    + +
    dicoGeneralSettings(arg)
    + +

    Arguments

    + + + + + + +
    arg

    An argument from function updateGeneralSettings.

    + +

    Value

    + +

    The corresponding Antares general parameter.

    + +

    Examples

    +
    dicoGeneralSettings("year.by.year") # "year-by-year"
    #> [1] "year-by-year"
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/dicoOptimizationSettings.html b/docs/reference/dicoOptimizationSettings.html new file mode 100644 index 00000000..06f915c6 --- /dev/null +++ b/docs/reference/dicoOptimizationSettings.html @@ -0,0 +1,163 @@ + + + + + + + + +Correspondence between arguments of <code>updateOptimizationSettings</code> and actual Antares parameters. — dicoOptimizationSettings • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Correspondence between arguments of updateOptimizationSettings and actual Antares parameters.

    +
    + +
    dicoOptimizationSettings(arg)
    + +

    Arguments

    + + + + + + +
    arg

    An argument from function updateOptimizationSettings.

    + +

    Value

    + +

    The corresponding Antares general parameter.

    + +

    Examples

    +
    dicoGeneralSettings("year.by.year") # "year-by-year"
    #> [1] "year-by-year"
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/editCluster.html b/docs/reference/editCluster.html new file mode 100644 index 00000000..107f483c --- /dev/null +++ b/docs/reference/editCluster.html @@ -0,0 +1,208 @@ + + + + + + + + +Edit an existing cluster — editCluster • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Edit an existing cluster

    +
    + +
    editCluster(
    +  area,
    +  cluster_name,
    +  ...,
    +  time_series = NULL,
    +  prepro_data = NULL,
    +  prepro_modulation = NULL,
    +  add_prefix = TRUE,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    area

    The area where the cluster is.

    cluster_name

    cluster name.

    ...

    Parameters to write in the Ini file.

    time_series

    the "ready-made" 8760-hour time-series available for simulation purposes.

    prepro_data

    Pre-process data, a data.frame or matrix, +default is a matrix with 365 rows and 6 columns.

    prepro_modulation

    Pre-process modulation, a data.frame or matrix, +if specified, must have 8760 rows and 1 or 4 columns.

    add_prefix

    If TRUE, cluster_name will be prefixed by area name.

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    An updated list containing various information about the simulation.

    + +

    Examples

    +
    if (FALSE) { + +# Update only nominalCapacity for an existing cluster +editCluster(area = "myarea", cluster_name = "mycluster", nominalcapacity = 10600.000) + +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/editLink.html b/docs/reference/editLink.html new file mode 100644 index 00000000..5f1dcfe6 --- /dev/null +++ b/docs/reference/editLink.html @@ -0,0 +1,247 @@ + + + + + + + + +Edit a link between two areas — editLink • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Edit a link between two areas

    +
    + +
    editLink(
    +  from,
    +  to,
    +  hurdles_cost = NULL,
    +  transmission_capacities = NULL,
    +  asset_type = NULL,
    +  display_comments = NULL,
    +  filter_synthesis = NULL,
    +  filter_year_by_year = NULL,
    +  dataLink = NULL,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    from

    The first area from which to create a link

    to

    The second one

    hurdles_cost

    Logical, which is used to state whether (linear) +transmission fees should be taken into account or not in economy and adequacy simulations

    transmission_capacities

    Character, one of enabled, ignore or infinite, which is used to state whether +the capacities to consider are those indicated in 8760-hour arrays or +if zero or infinite values should be used instead (actual values / set to zero / set to infinite)

    asset_type

    Character, one of ac, dc, gas, virt or other. Used to +state whether the link is either an AC component (subject to Kirchhoff’s laws), a DC component, +or another type of asset.

    display_comments

    Logical

    filter_synthesis

    Output synthesis

    filter_year_by_year

    Output year-by-year

    dataLink

    For Antares v7, a matrix with eight column corresponding to : trans. capacity (direct) +trans. capacity (indirect), hurdles cost (direct), hurdles cost (indirect), impedances, loop flow, +PST min, PST max. +If NULL (default), a matrix whose rows are equal to 1, 1, 0, 0, 0, 0, 0, 0 is set. See Details

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    An updated list containing various information about the simulation.

    +

    Details

    + +

    The eight times-series are:

      +
    • "NTC direct"the upstream-to-downstream capacity, in MW

    • +
    • "NTC indirect"the downstream-to-upstream capacity, in MW

    • +
    • "Hurdle cost direct"an upstream-to-downstream transmission fee, in euro/MWh

    • +
    • "Hurdle cost indirect"a downstream-to-upstream transmission fee, in euro/MWh

    • +
    • "Impedances"virtual impedances that are used in economy simulations to give a physical meaning to raw outputs, when no binding constraints have been defined to enforce Kirchhoff's laws.

    • +
    • "Loop flow"amount of power flowing circularly though the grid when all “nodes” are perfectly balanced (no import and no export).

    • +
    • "PST min"lower bound of phase-shifting that can be reached by a PST installed on the link, if any.

    • +
    • "PST max"upper bound of phase-shifting that can be reached by a PST installed on the link, if any.

    • +

    NB: For Antares v7 the eight columns must conform to above order. For Antares v6, only five columns are +expected, and they must follow this other order: NTC direct, NTC indirect, Impedances, Hurdle cost direct, +Hurdle cost indirect.

    +

    Note

    + +

    In Antares, areas are sorted in alphabetical order to establish links between. +For example, link between "fr" and "be" will appear under "be". +So the areas are sorted before creating the link between them, and dataLink is +rearranged to match the new order.

    + +

    Examples

    +
    if (FALSE) { +editLink( + from = "area1", + to = "area2", + transmission_capacities = "infinite" +) +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/figures/antares_simulator.png b/docs/reference/figures/antares_simulator.png new file mode 100644 index 00000000..0115f089 Binary files /dev/null and b/docs/reference/figures/antares_simulator.png differ diff --git a/docs/reference/filteringOptions.html b/docs/reference/filteringOptions.html new file mode 100644 index 00000000..6397a168 --- /dev/null +++ b/docs/reference/filteringOptions.html @@ -0,0 +1,175 @@ + + + + + + + + +Output profile options for creating an area — filteringOptions • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Output profile options for creating an area

    +
    + +
    filteringOptions(
    +  filter_synthesis = c("hourly", "daily", "weekly", "monthly", "annual"),
    +  filter_year_by_year = c("hourly", "daily", "weekly", "monthly", "annual")
    +)
    + +

    Arguments

    + + + + + + + + + + +
    filter_synthesis

    Output synthesis

    filter_year_by_year

    Output Year-by-year

    + +

    Value

    + +

    a named list

    + +

    Examples

    +
    filteringOptions()
    #> $`filter-synthesis` +#> [1] "hourly" "daily" "weekly" "monthly" "annual" +#> +#> $`filter-year-by-year` +#> [1] "hourly" "daily" "weekly" "monthly" "annual" +#>
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/getPlaylist.html b/docs/reference/getPlaylist.html new file mode 100644 index 00000000..b95a500b --- /dev/null +++ b/docs/reference/getPlaylist.html @@ -0,0 +1,165 @@ + + + + + + + + +Get the playlist of an Antares study — getPlaylist • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    getPlaylist gives the identifier of the MC years which +will be simulated in the Antares study, taking into account the potential use of a +playlist which can skip some MC years

    +
    + +
    getPlaylist(opts = antaresRead::simOptions())
    + +

    Arguments

    + + + + + + +
    opts

    list of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    Returns a vector of the identifier of the simulated MC year

    + +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/index.html b/docs/reference/index.html new file mode 100644 index 00000000..4d38a862 --- /dev/null +++ b/docs/reference/index.html @@ -0,0 +1,376 @@ + + + + + + + + +Function reference • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +

    All functions

    +

    +
    +

    backupStudy()

    +

    Create a backup with an Antares Study

    +

    checkRemovedArea()

    +

    Seek for a removed area

    +

    createArea()

    +

    Create An Area In An Antares Study

    +

    createBindingConstraint()

    +

    Create a Binding Constraint

    +

    createCluster()

    +

    Create a thermal cluster

    +

    createDistrict()

    +

    Create a district

    +

    createDSR() getCapacityDSR() editDSR()

    +

    Create a Demand Side Response (DSR)

    +

    createLink()

    +

    Create a link between two areas

    +

    createPSP() getCapacityPSP() editPSP()

    +

    Create a Pumped Storage Power plant (PSP)

    +

    createStudy()

    +

    Create an empty Antares study

    +

    dicoGeneralSettings()

    +

    Correspondence between arguments of updateGeneralSettings and actual Antares parameters.

    +

    dicoOptimizationSettings()

    +

    Correspondence between arguments of updateOptimizationSettings and actual Antares parameters.

    +

    editCluster()

    +

    Edit an existing cluster

    +

    editLink()

    +

    Edit a link between two areas

    +

    filteringOptions()

    +

    Output profile options for creating an area

    +

    getPlaylist()

    +

    Get the playlist of an Antares study

    +

    is_antares_v7()

    +

    Is study an Antares v7 study ?

    +

    nodalOptimizationOptions()

    +

    Nodal optimization parameters for creating an area

    +

    propertiesLinkOptions()

    +

    Properties for creating a link

    +

    readIniFile()

    +

    Read a INI file

    +

    removeArea()

    +

    Remove An Area From inputs

    +

    removeBindingConstraint()

    +

    Remove a Binding Constraint

    +

    removeCluster()

    +

    Remove a cluster

    +

    removeLink()

    +

    Remove a link between two ares

    +

    runSimulation()

    +

    Run an Antares Simulation

    +

    runTsGenerator()

    +

    Run Time-Series Generator

    +

    scenarioBuilder() readScenarioBuilder() updateScenarioBuilder()

    +

    Read, create & update scenario builder

    +

    setPlaylist()

    +

    Set the playlist of an Antares Study

    +

    setSolverPath()

    +

    Set path to Antares Solver

    +

    updateGeneralSettings()

    +

    Update general parameters of an Antares study

    +

    updateInputSettings()

    +

    Update input parameters of an Antares study

    +

    updateOptimizationSettings()

    +

    Update optimization parameters of an Antares study

    +

    updateOutputSettings()

    +

    Update output parameters of an Antares study

    +

    writeIni()

    +

    Write ini file from list obtain by antaresRead:::readIniFile and modify by user

    +

    writeInputTS()

    +

    Write input time series

    +

    writeSeriesPrepro()

    +

    Write prepro data

    +

    writeWaterValues()

    +

    Write water values

    +
    + + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/is_antares_v7.html b/docs/reference/is_antares_v7.html new file mode 100644 index 00000000..72558fc4 --- /dev/null +++ b/docs/reference/is_antares_v7.html @@ -0,0 +1,170 @@ + + + + + + + + +Is study an Antares v7 study ? — is_antares_v7 • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Is study an Antares v7 study ?

    +
    + +
    is_antares_v7(opts = antaresRead::simOptions())
    + +

    Arguments

    + + + + + + +
    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    a logical, TRUE if study is v7 or above, FALSE otherwise

    + +

    Examples

    +
    +if (FALSE) { +# setSimulationPath + +is_antares_v7() + +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/nodalOptimizationOptions.html b/docs/reference/nodalOptimizationOptions.html new file mode 100644 index 00000000..64708c1d --- /dev/null +++ b/docs/reference/nodalOptimizationOptions.html @@ -0,0 +1,199 @@ + + + + + + + + +Nodal optimization parameters for creating an area — nodalOptimizationOptions • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Nodal optimization parameters for creating an area

    +
    + +
    nodalOptimizationOptions(
    +  non_dispatchable_power = TRUE,
    +  dispatchable_hydro_power = TRUE,
    +  other_dispatchable_power = TRUE,
    +  spread_unsupplied_energy_cost = 0,
    +  spread_spilled_energy_cost = 0
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + +
    non_dispatchable_power

    logical, default to FALSE

    dispatchable_hydro_power

    logical, default to FALSE

    other_dispatchable_power

    logical, default to FALSE

    spread_unsupplied_energy_cost

    numeric, default to 0

    spread_spilled_energy_cost

    numeric, default to 0

    + +

    Value

    + +

    a named list

    + +

    Examples

    +
    nodalOptimizationOptions()
    #> $`non-dispatchable-power` +#> [1] TRUE +#> +#> $`dispatchable-hydro-power` +#> [1] TRUE +#> +#> $`other-dispatchable-power` +#> [1] TRUE +#> +#> $`spread-unsupplied-energy-cost` +#> [1] 0 +#> +#> $`spread-spilled-energy-cost` +#> [1] 0 +#>
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/propertiesLinkOptions.html b/docs/reference/propertiesLinkOptions.html new file mode 100644 index 00000000..cb500d60 --- /dev/null +++ b/docs/reference/propertiesLinkOptions.html @@ -0,0 +1,197 @@ + + + + + + + + +Properties for creating a link — propertiesLinkOptions • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Properties for creating a link

    +
    + +
    propertiesLinkOptions(
    +  hurdles_cost = FALSE,
    +  transmission_capacities = "enabled",
    +  asset_type = "ac",
    +  display_comments = TRUE,
    +  filter_synthesis = c("hourly", "daily", "weekly", "monthly", "annual"),
    +  filter_year_by_year = c("hourly", "daily", "weekly", "monthly", "annual")
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    hurdles_cost

    Logical, which is used to state whether (linear) +transmission fees should be taken into account or not in economy and adequacy simulations

    transmission_capacities

    Character, one of enabled, ignore or infinite, which is used to state whether +the capacities to consider are those indicated in 8760-hour arrays or +if zero or infinite values should be used instead (actual values / set to zero / set to infinite)

    asset_type

    Character, one of ac, dc, gas, virt or other. Used to +state whether the link is either an AC component (subject to Kirchhoff’s laws), a DC component, +or another type of asset.

    display_comments

    Logical

    filter_synthesis

    Output synthesis

    filter_year_by_year

    Output year-by-year

    + +

    Value

    + +

    A named list

    + +

    Examples

    +
    if (FALSE) { +propertiesLinkOptions() +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/readIniFile.html b/docs/reference/readIniFile.html new file mode 100644 index 00000000..735f7c2e --- /dev/null +++ b/docs/reference/readIniFile.html @@ -0,0 +1,164 @@ + + + + + + + + +Read a INI file — readIniFile • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Read a INI file

    +
    + +
    readIniFile(file, stringsAsFactors = FALSE)
    + +

    Arguments

    + + + + + + + + + + +
    file

    file path.

    stringsAsFactors

    logical: should character vectors be converted to factors?

    + +

    Value

    + +

    A list with an element for each section of the .ini file.

    + +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/removeArea.html b/docs/reference/removeArea.html new file mode 100644 index 00000000..34b4b617 --- /dev/null +++ b/docs/reference/removeArea.html @@ -0,0 +1,170 @@ + + + + + + + + +Remove An Area From inputs — removeArea • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Remove An Area From inputs

    +
    + +
    removeArea(name, opts = antaresRead::simOptions())
    + +

    Arguments

    + + + + + + + + + + +
    name

    An area name

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    An updated list containing various information about the simulation.

    + +

    Examples

    +
    if (FALSE) { +removeArea("fictive_area") +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/removeBindingConstraint.html b/docs/reference/removeBindingConstraint.html new file mode 100644 index 00000000..1b331adc --- /dev/null +++ b/docs/reference/removeBindingConstraint.html @@ -0,0 +1,170 @@ + + + + + + + + +Remove a Binding Constraint — removeBindingConstraint • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Remove a Binding Constraint

    +
    + +
    removeBindingConstraint(name, opts = antaresRead::simOptions())
    + +

    Arguments

    + + + + + + + + + + +
    name

    Name(s) of the binding constraint(s) to remove.

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    An updated list containing various information about the simulation.

    + +

    Examples

    +
    if (FALSE) { +removeBindingConstraint("mybindingconstraint") +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/removeCluster.html b/docs/reference/removeCluster.html new file mode 100644 index 00000000..dbf3ff4f --- /dev/null +++ b/docs/reference/removeCluster.html @@ -0,0 +1,187 @@ + + + + + + + + +Remove a cluster — removeCluster • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Remove a cluster

    +
    + +
    removeCluster(
    +  area,
    +  cluster_name,
    +  add_prefix = TRUE,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + +
    area

    Area from which to remove a cluster.

    cluster_name

    Cluster to remove.

    add_prefix

    If TRUE, cluster_name will be prefixed by area's name.

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    An updated list containing various information about the simulation.

    + +

    Examples

    +
    if (FALSE) { +createCluster(area = "fr", cluster_name = "fr_gas", + group = "other", `marginal-cost` = 50) + +removeCluster(area = "fr", cluster_name = "fr_gas") + +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/removeLink.html b/docs/reference/removeLink.html new file mode 100644 index 00000000..bd07b429 --- /dev/null +++ b/docs/reference/removeLink.html @@ -0,0 +1,175 @@ + + + + + + + + +Remove a link between two ares — removeLink • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Remove a link between two ares

    +
    + +
    removeLink(from, to, opts = antaresRead::simOptions())
    + +

    Arguments

    + + + + + + + + + + + + + + +
    from

    The first area from which to create a link

    to

    The second one

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    An updated list containing various information about the simulation.

    + +

    Examples

    +
    if (FALSE) { +createLink(from = "myarea", to = "myarea2") +removeLink(from = "myarea", to = "myarea2") +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/runSimulation.html b/docs/reference/runSimulation.html new file mode 100644 index 00000000..2c2a1666 --- /dev/null +++ b/docs/reference/runSimulation.html @@ -0,0 +1,200 @@ + + + + + + + + +Run an Antares Simulation — runSimulation • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    run_simulation is a function which runs an ANTARES study +in economic mode

    +
    + +
    runSimulation(
    +  name,
    +  mode = "economy",
    +  path_solver = getOption("antares.solver"),
    +  wait = TRUE,
    +  show_output_on_console = FALSE,
    +  parallel = TRUE,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    name

    Name of the simulation.

    mode

    Simulation mode, can take value "economy", "adequacy" or "draft".

    path_solver

    Character containing the Antares Solver path

    wait

    Logical, indicating whether the R interpreter should wait for the +simulation to finish, or run it asynchronously.

    show_output_on_console

    Logical, indicating whether to capture the ANTARES log and show +it on the R console.

    parallel

    Logical. If TRUE the ANTARES simulation will be run in parallel mode (Work +only with ANTARES v6.0.0 or more). In that case, the number of cores used by the simulation +is the one set in advanced_settings/simulation_cores (see ANTARES interface).

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    The function does not return anything. It is used to launch an +ANTARES simulation

    + +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/runTsGenerator.html b/docs/reference/runTsGenerator.html new file mode 100644 index 00000000..70f1c242 --- /dev/null +++ b/docs/reference/runTsGenerator.html @@ -0,0 +1,188 @@ + + + + + + + + +Run Time-Series Generator — runTsGenerator • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Run Time-Series Generator

    +
    + +
    runTsGenerator(
    +  path_solver = getOption("antares.solver"),
    +  wait = TRUE,
    +  show_output_on_console = FALSE,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + +
    path_solver

    Character containing the Antares Solver path.

    wait

    Logical, indicating whether the R interpreter should wait for the +simulation to finish, or run it asynchronously.

    show_output_on_console

    Logical, indicating whether to capture the ANTARES log and show +it on the R console.

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath.

    + + +

    Examples

    +
    if (FALSE) { +library(antaresRead) +setSimulationPath(path = "path/to/study") + +library(antaresEditObject) +runTsGenerator( + path_solver = "path/to/antares-6.0-solver.exe", + show_output_on_console = TRUE +) +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/scenario-builder.html b/docs/reference/scenario-builder.html new file mode 100644 index 00000000..979e1d0e --- /dev/null +++ b/docs/reference/scenario-builder.html @@ -0,0 +1,269 @@ + + + + + + + + +Read, create & update scenario builder — scenario-builder • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Read, create & update scenario builder

    +
    + +
    scenarioBuilder(
    +  n_scenario,
    +  n_mc = NULL,
    +  areas = NULL,
    +  areas_rand = NULL,
    +  opts = antaresRead::simOptions()
    +)
    +
    +readScenarioBuilder(
    +  ruleset = "Default Ruleset",
    +  as_matrix = TRUE,
    +  opts = antaresRead::simOptions()
    +)
    +
    +updateScenarioBuilder(
    +  ldata,
    +  ruleset = "Default Ruleset",
    +  series = NULL,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    n_scenario

    Number of scenario.

    n_mc

    Number of Monte-Carlo years.

    areas

    Areas to use in scenario builder, if NULL (default), areas in Antares study are used.

    areas_rand

    Areas for which to use "rand".

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    ruleset

    Ruleset to read.

    as_matrix

    If TRUE (default) return a matrix, else a list.

    ldata

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

    series

    Name(s) of the serie(s) to update if ldata is a single matrix.

    + +

    Value

    + +

    scenarioBuilder : a matrix

    +

    readScenarioBuilder : a list of matrix or list

    + +

    Examples

    +
    if (FALSE) { + +library(antaresRead) +library(antaresEditObject) + +# simulation path +setSimulationPath( + path = "pat/to/simulation", + simulation = "input" +) + +# Create a scenario builder matrix +sbuilder <- scenarioBuilder( + n_scenario = 51, + n_mc = 2040, + areas_rand = c("fr", "be") +) +sbuilder[, 1:6] +dim(sbuilder) + + +# Read previous scenario builder +# in a matrix format +prev_sb <- readScenarioBuilder() + + +# Update scenario builder + +# for load serie +updateScenarioBuilder(ldata = sbuilder, series = "load") + +# equivalent as +updateScenarioBuilder(ldata = list(l = sbuilder)) + + +# update several series + +# same input +sbuilder +updateScenarioBuilder( + ldata = sbuilder, + series = c("load", "hydro", "solar") +) + +# different input +updateScenarioBuilder(ldata = list( + l = load_sb, + h = hydro_sb, + s = solar_sb +)) + +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/setPlaylist.html b/docs/reference/setPlaylist.html new file mode 100644 index 00000000..2e61e091 --- /dev/null +++ b/docs/reference/setPlaylist.html @@ -0,0 +1,168 @@ + + + + + + + + +Set the playlist of an Antares Study — setPlaylist • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    set_playlist is a function which modifies the input file of an ANTARES +study and set the playlist in order to simulate only the MC years given in input

    +
    + +
    setPlaylist(playlist, opts = antaresRead::simOptions())
    + +

    Arguments

    + + + + + + + + + + +
    playlist

    vector of MC years identifier to be simulated

    opts

    list of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    The function does not return anything. It is used to modify the input of an +Antares study

    + +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/setSolverPath.html b/docs/reference/setSolverPath.html new file mode 100644 index 00000000..5cc7db42 --- /dev/null +++ b/docs/reference/setSolverPath.html @@ -0,0 +1,165 @@ + + + + + + + + +Set path to Antares Solver — setSolverPath • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Set path to Antares Solver

    +
    + +
    setSolverPath(path)
    + +

    Arguments

    + + + + + + +
    path

    (optional) Path to the solver (e.g. antares-6.0-solver.exe in \bin directory where Antares is installed). +If missing, a window opens and lets the user choose the directory of the simulation interactively.

    + + +

    Examples

    +
    +if (FALSE) { + +setSolverPath(path = "C:/antares/bin/antares-6.0-solver.exe") + +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/updateGeneralSettings.html b/docs/reference/updateGeneralSettings.html new file mode 100644 index 00000000..edd00044 --- /dev/null +++ b/docs/reference/updateGeneralSettings.html @@ -0,0 +1,316 @@ + + + + + + + + +Update general parameters of an Antares study — updateGeneralSettings • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Update general parameters of an Antares study

    +
    + +
    updateGeneralSettings(
    +  mode = NULL,
    +  horizon = NULL,
    +  nbyears = NULL,
    +  simulation.start = NULL,
    +  simulation.end = NULL,
    +  january.1st = NULL,
    +  first.month.in.year = NULL,
    +  first.weekday = NULL,
    +  leapyear = NULL,
    +  year.by.year = NULL,
    +  derated = NULL,
    +  custom.ts.numbers = NULL,
    +  user.playlist = NULL,
    +  filtering = NULL,
    +  active.rules.scenario = NULL,
    +  generate = NULL,
    +  nbtimeseriesload = NULL,
    +  nbtimeserieshydro = NULL,
    +  nbtimeserieswind = NULL,
    +  nbtimeseriesthermal = NULL,
    +  nbtimeseriessolar = NULL,
    +  refreshtimeseries = NULL,
    +  intra.modal = NULL,
    +  inter.modal = NULL,
    +  refreshintervalload = NULL,
    +  refreshintervalhydro = NULL,
    +  refreshintervalwind = NULL,
    +  refreshintervalthermal = NULL,
    +  refreshintervalsolar = NULL,
    +  readonly = NULL,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    mode

    Economy, Adequacy, Draft.

    horizon

    Reference year (static tag, not used in the calculations)

    nbyears

    Number of Monte-Carlo years that should be prepared for the simulation (not always the same as the Number of MC years actually simulated, see 'selection mode' below).

    simulation.start

    First day of the simulation (e.g. 8 for a simulation beginning on the second week of the first month of the year)

    simulation.end

    Last day of the simulation (e.g. 28 for a simulation ending on the fourth week of the first month of the year)

    january.1st

    First day of the year (Mon, Tue, etc.).

    first.month.in.year

    Actual month by which the Time-series begin (Jan to Dec, Oct to Sep, etc.)

    first.weekday

    In economy or adequacy simulations, indicates the frame (Mon- Sun, Sat-Fri, etc.) to use for the edition of weekly results.

    leapyear

    (TRUE/FALSE) indicates whether February has 28 or 29 days.

    year.by.year

    (False) No individual results will be printed out, +(True) For each simulated year, detailed results will be +printed out in an individual directory7 : + Study_name/OUTPUT/simu_tag/Economy /mc-i-number

    derated

    See Antares General Reference Guide.

    custom.ts.numbers

    See Antares General Reference Guide.

    user.playlist

    See Antares General Reference Guide.

    filtering

    See Antares General Reference Guide.

    active.rules.scenario

    See Antares General Reference Guide.

    generate

    See Antares General Reference Guide.

    nbtimeseriesload

    See Antares General Reference Guide.

    nbtimeserieshydro

    See Antares General Reference Guide.

    nbtimeserieswind

    See Antares General Reference Guide.

    nbtimeseriesthermal

    See Antares General Reference Guide.

    nbtimeseriessolar

    See Antares General Reference Guide.

    refreshtimeseries

    See Antares General Reference Guide.

    intra.modal

    See Antares General Reference Guide.

    inter.modal

    See Antares General Reference Guide.

    refreshintervalload

    See Antares General Reference Guide.

    refreshintervalhydro

    See Antares General Reference Guide.

    refreshintervalwind

    See Antares General Reference Guide.

    refreshintervalthermal

    See Antares General Reference Guide.

    refreshintervalsolar

    See Antares General Reference Guide.

    readonly

    See Antares General Reference Guide.

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    An updated list containing various information about the simulation.

    + +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/updateInputSettings.html b/docs/reference/updateInputSettings.html new file mode 100644 index 00000000..2689fc09 --- /dev/null +++ b/docs/reference/updateInputSettings.html @@ -0,0 +1,173 @@ + + + + + + + + +Update input parameters of an Antares study — updateInputSettings • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Update input parameters of an Antares study

    +
    + +
    updateInputSettings(import, opts = antaresRead::simOptions())
    + +

    Arguments

    + + + + + + + + + + +
    import

    Series to import.

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    An updated list containing various information about the simulation.

    + +

    Examples

    +
    if (FALSE) { + +updateInputSettings(import = c("thermal")) +updateInputSettings(import = c("hydro", "thermal")) + +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/updateOptimizationSettings.html b/docs/reference/updateOptimizationSettings.html new file mode 100644 index 00000000..b8b88979 --- /dev/null +++ b/docs/reference/updateOptimizationSettings.html @@ -0,0 +1,248 @@ + + + + + + + + +Update optimization parameters of an Antares study — updateOptimizationSettings • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Update optimization parameters of an Antares study

    +
    + +
    updateOptimizationSettings(
    +  simplex.range = NULL,
    +  transmission.capacities = NULL,
    +  include.constraints = NULL,
    +  include.hurdlecosts = NULL,
    +  include.tc.min.stable.power = NULL,
    +  include.tc.min.up.down.time = NULL,
    +  include.dayahead = NULL,
    +  include.strategicreserve = NULL,
    +  include.spinningreserve = NULL,
    +  include.primaryreserve = NULL,
    +  include.exportmps = NULL,
    +  power.fluctuations = NULL,
    +  shedding.strategy = NULL,
    +  shedding.policy = NULL,
    +  unit.commitment.mode = NULL,
    +  number.of.cores.mode = NULL,
    +  day.ahead.reserve.management = NULL,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    simplex.range

    week or day

    transmission.capacities

    true, false or infinite

    include.constraints

    true or false

    include.hurdlecosts

    true or false

    include.tc.min.stable.power

    true or false

    include.tc.min.up.down.time

    true or false

    include.dayahead

    true or false

    include.strategicreserve

    true or false

    include.spinningreserve

    true or false

    include.primaryreserve

    true or false

    include.exportmps

    true or false

    power.fluctuations

    free modulations, minimize excursions or minimize ramping

    shedding.strategy

    share margins

    shedding.policy

    shave peaks or minimize duration

    unit.commitment.mode

    fast or accurate

    number.of.cores.mode

    minimum, low, medium, high or maximum

    day.ahead.reserve.management

    global

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    An updated list containing various information about the simulation options.

    + +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/updateOutputSettings.html b/docs/reference/updateOutputSettings.html new file mode 100644 index 00000000..d2b7aca7 --- /dev/null +++ b/docs/reference/updateOutputSettings.html @@ -0,0 +1,188 @@ + + + + + + + + +Update output parameters of an Antares study — updateOutputSettings • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Update output parameters of an Antares study

    +
    + +
    updateOutputSettings(
    +  synthesis = NULL,
    +  storenewset = NULL,
    +  archives = NULL,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + +
    synthesis

    Logical. If TRUE, synthetic results will be stored in a +directory Study_name/OUTPUT/simu_tag/Economy/mc-all. If FALSE, No general +synthesis will be printed out.

    storenewset

    Logical. See Antares General Reference Guide.

    archives

    Character vector. Series to archive.

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath

    + +

    Value

    + +

    An updated list containing various information about the simulation.

    + +

    Examples

    +
    if (FALSE) { + +updateOutputSettings(synthesis = TRUE, storenewset = FALSE, + archives = c("load", "wind")) + +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/writeIni.html b/docs/reference/writeIni.html new file mode 100644 index 00000000..9a702892 --- /dev/null +++ b/docs/reference/writeIni.html @@ -0,0 +1,173 @@ + + + + + + + + +Write ini file from list obtain by antaresRead:::readIniFile and modify by user — writeIni • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Write ini file from list obtain by antaresRead:::readIniFile and modify by user

    +
    + +
    writeIni(listData, pathIni, overwrite = FALSE)
    + +

    Arguments

    + + + + + + + + + + + + + + +
    listData

    list, modified list obtained by antaresRead:::readIniFile.

    pathIni

    Character, Path to ini file.

    overwrite

    logical, should file be overwritten if already exist?

    + + +

    Examples

    +
    +if (FALSE) { +pathIni <- "D:/exemple_test/settings/generaldata.ini" +generalSetting <- antaresRead:::readIniFile(pathIni) +generalSetting$output$synthesis <- FALSE +writeIni(generalSetting, pathIni) +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/writeInputTS.html b/docs/reference/writeInputTS.html new file mode 100644 index 00000000..41c88acb --- /dev/null +++ b/docs/reference/writeInputTS.html @@ -0,0 +1,187 @@ + + + + + + + + +Write input time series — writeInputTS • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    This function writes input time series in an Antares project.

    +
    + +
    writeInputTS(
    +  area,
    +  type = c("load", "thermal", "hydro", "wind", "solar"),
    +  data,
    +  overwrite = TRUE,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + +
    area

    The area where to write the input time series.

    type

    Serie to write: "load", "thermal", "hydro", +"wind" or "solar".

    data

    A 8760*N matrix of hourly time series.

    overwrite

    Logical. Overwrite the values if a file already exists.

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath.

    + + +

    Examples

    +
    if (FALSE) { + +writeInputTS("fictive_area", type = "thermal", data = matrix(rep(4, 8760*2), nrow = 8760)) + +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/writeSeriesPrepro.html b/docs/reference/writeSeriesPrepro.html new file mode 100644 index 00000000..630b4f10 --- /dev/null +++ b/docs/reference/writeSeriesPrepro.html @@ -0,0 +1,212 @@ + + + + + + + + +Write prepro data — writeSeriesPrepro • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    This function allows to write load, wind and solar prepro data. Using +character(0) allows to erase data (cf Examples).

    +
    + +
    writeSeriesPrepro(
    +  area,
    +  type = c("load", "wind", "solar"),
    +  coefficients = NULL,
    +  daily_profile = NULL,
    +  translation = NULL,
    +  conversion = NULL,
    +  overwrite = TRUE,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    area

    The area where to write prepro data.

    type

    Type of data to write : "load", "wind" or "solar".

    coefficients

    A 12*6 matrix of monthly values for the primary +parameters alpha, beta, gamma, delta, theta and mu.

    daily_profile

    A 24*12 matrix of hourly / monthly coefficients K(hm) +that are used to modulate the values of the stationary stochastic process +by which the actual process is approximated.

    translation

    A vector of length 8760 (or 8760*1 matrix) to add to the +time-series generated, prior or after scaling.

    conversion

    A 2*N matrix (with 1<=N<=50) that is used to turn the +initial time-series produced by the generators into final data. See Antares +General Reference Guide.

    overwrite

    Logical. Overwrite the values if a file already exists.

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath.

    + + +

    Examples

    +
    if (FALSE) { + +writeSeriesPrepro("fictive_area", type = "solar", daily_profile = matrix(rep(1, 24*12), nrow = 24)) + +# Erase daily profile data: +writeSeriesPrepro("fictive_area", type = "solar", daily_profile = character(0)) + +}
    +
    + +
    + + +
    + + +
    +

    Site built with pkgdown 1.4.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/writeWaterValues.html b/docs/reference/writeWaterValues.html new file mode 100644 index 00000000..8d726548 --- /dev/null +++ b/docs/reference/writeWaterValues.html @@ -0,0 +1,185 @@ + + + + + + + + +Write water values — writeWaterValues • antaresEditObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    + + +
    +

    Write water values

    +
    + +
    writeWaterValues(
    +  area,
    +  data = NULL,
    +  overwrite = TRUE,
    +  opts = antaresRead::simOptions()
    +)
    + +

    Arguments

    + + + + + + + + + + + + + + + + + + +
    area

    The area where to add the water values.

    data

    A 365*101 numeric matrix: table of marginal values for the stored energy, which depends +on the date (365 days) and on the reservoir level (101 round percentage values ranging from +0% to 100%). OR a 3-column matrix with 365*101 rows. In this latter case the 3 columns must +be 'date', 'level' and 'value' (in this order), and the rows must be sorted by: +ascending day, ascending level.

    overwrite

    Logical. Overwrite the values if a file already exists.

    opts

    List of simulation parameters returned by the function +antaresRead::setSimulationPath.

    + + +

    Examples

    +
    if (FALSE) { + +writeWaterValues("fictive_area", data = matrix(rep(0, 365*101), nrow = 365)) + +}
    +
    + +
    + + + +
    + + + + + + + +