antaresread

Import, manipulate and explore the results of an Antares simulation

https://github.com/rte-antares-rpackage/antaresread

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (17.1%) to scientific vocabulary

Keywords

adequacy bilan electricity energy hdf5 linear-algebra monte-carlo-simulation optimisation previsionnel r rhdf5 rte simulation tyndp

Keywords from Contributors

shiny-apps shiny dygraphs electric manipulatewidge plotly renewable-energy stochastic-simulation-algorithm shinyapps logs

Last synced: 6 months ago · JSON representation

Repository

Import, manipulate and explore the results of an Antares simulation

Basic Info

Host: GitHub
Owner: rte-antares-rpackage
Language: R
Default Branch: master
Homepage: https://rte-antares-rpackage.github.io/antaresRead/
Size: 68.8 MB

Statistics

Stars: 13
Watchers: 6
Forks: 6
Open Issues: 8
Releases: 22

Topics

adequacy bilan electricity energy hdf5 linear-algebra monte-carlo-simulation optimisation previsionnel r rhdf5 rte simulation tyndp

Created over 9 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog License

antaresRead

Read data from an Antares study with R package 'antaresRead'

Installation

You can install the package from CRAN: r install.packages("antaresRead")

You can also install the last development version from Github: r devtools::install_github("rte-antares-rpackage/antaresRead")

To display the help of the package and see all the functions it provides, type: r help(package="antaresRead")

To see a practical example of use of the package, look at the vignette : r vignette("antares")

Finally, you can download a cheatsheet that summarize in a single page how to use the package: https://github.com/rte-antares-rpackage/antaresRead/raw/master/cheatsheet/antarescheatsheeten.pdf .

See website for more documentation: https://rte-antares-rpackage.github.io/antaresRead/

Initialisation

Load the package

r library(antaresRead)

Select an Antares simulation interactively.

r setSimulationPath()

You can also select it programmatically:

r setsimulationPath("study_path", simulation)

The parameter simulation can be the name of a simulation, the name of the folder containing the simulation results, or the index of the simulation. 1 corresponds to the oldest simulation, -1 to the newest one, 0 to the inputs.

Read data from a simulation

Most data from a simulation can be imported in the R session with function readAntares(). It has many parameters that control what data is imported. Here are a few examples:

```r

Read synthetic results of all areas of a study with hourly time step.

areaData <- readAntares(areas = "all")

Same but with a daily time step:

areaData <- readAntares(areas = "all", timeStep = "daily")

Read all Monte Carlo scenarios for a given area.

myArea <- readAntares(areas = "my_area", mcYears = "all")

Same but add miscelaneous production time series to the result

myArea <- readAntares(areas = "my_area", mcYears = "all", misc = TRUE)

Read only columns "LOAD" and "MRG. PRICE"

areaData <- readAntares(areas = "all", select = c("LOAD", "MRG. PRICE")) ```

Functions getAreas and getLinks are helpful to create a selection of areas or links of interest. Here are a few examples:

```r

select areas containing "fr"

myareas <- getAreas("fr")

Same but remove areas containing "hvdc"

myareas <- getAreas("fr", exclude = "hvdc")

Get the links that connect two of the previous areas

mylinks <- getLinks(myareas, internalOnly = FALSE)

Get the results for these areas and links

mydata <- readAntares(areas = myareas, links = mylinks) ```

Work with the imported data

When only one type of elements is imported (only areas or only links, etc.) readAntares() read antares returns a data.table with some extra attributes. A data.table is a table with some enhanced capacities offered by package data.table. In particular it provides a special syntax to manipulate its content:

r name_of_the_table[filter_rows, select_columns, group_by]

Here are some examples:

```r

Select lines based on some criteria

mydata[area == "fr" & month == "JUL"]

Select columns, and compute new ones

mydata[, .(area, month, load2 = LOAD^2)]

Aggregate data by some variables

mydata[, .(total = sum(LOAD)), by = .(month)]

All three operations can be done with a single line of code

mydata[area == "fr", .(total = sum(LOAD)), by = .(month)]

help(package = "data.table") ```

If you are not familiar with package data.table, you should have a look at the documentation and especially at the vignettes of the package:

r help(package="data.table") vignette("datatable-intro")

Contributing:

Contributions to the library are welcome and can be submitted in the form of pull requests to this repository.

The folder test_case contains a test Antares study used to run automatic tests. If you modifies it, you need to run the following command to include the modifications in the tests:

```r saveWd<-getwd() setwd('inst/testdata/') tar( tarfile = "antares-test-study.tar.gz", files = "test_case", compression = "gzip" )

setwd(saveWd) ```

ANTARES :

Antares is a powerful software developed by RTE to simulate and study electric power systems (more information about Antares here : https://antares-simulator.org/).

ANTARES is now an open-source project (since 2018), you can download the sources here if you want to use this package.

License Information:

RTE: https://www.rte-france.com

This Source Code is subject to the terms of the GNU General Public License, version 2 or any higher version. If a copy of the GPL-v2 was not distributed with this file, You can obtain one at https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html.

Owner

Name: rte-antares-rpackage
Login: rte-antares-rpackage
Kind: organization
Email: rte-antares-rpackage@rte-france.com

Website: https://rte-antares-rpackage.github.io/rPackagesRte/
Repositories: 30
Profile: https://github.com/rte-antares-rpackage

RTE ANTARES R PACKAGE

GitHub Events

Total

Create event: 25
Issues event: 1
Release event: 1
Delete event: 18
Member event: 1
Issue comment event: 3
Push event: 99
Pull request review event: 6
Pull request event: 50

Last Year

Create event: 25
Issues event: 1
Release event: 1
Delete event: 18
Member event: 1
Issue comment event: 3
Push event: 99
Pull request review event: 6
Pull request event: 50

Committers

Last synced: 6 months ago

All Time

Total Commits: 927
Total Committers: 27
Avg Commits per committer: 34.333
Development Distribution Score (DDS): 0.655

Past Year

Commits: 31
Committers: 4
Avg Commits per committer: 7.75
Development Distribution Score (DDS): 0.484

Top Committers

Name	Email	Commits
françois GUILLEM	f**m@r**m	320
zawam	j**m@r**m	202
TitouanRobert	t**o@g**m	149
Benoit Thieurmel	b**l@g**m	45
Benoit Thieurmel	b**l@d**r	44
pvictor	p**r@g**m	40
Clément Berthet	c**3@g**m	35
Etienne	e**z@d**r	18
AssilMa	4****a	15
KKamel67	5****7	13
MANSOURI Assil Ext	a**i@r**m	13
unknown	j**a@G**m	6
Mahabd	1****7	4
Baptiste	b**t@r**m	3
PPlessiez	p**z@r**m	3
Paul Bui-Quang	p**g@r**m	3
Benoit Thieurmel	b**l@p**r	3
kemihak	k**a@r**m	2
vargastat	1****t	1
BERTHET Clement (Externe)	c**e@r**m	1
BERTHET Clement Ext	c**t@r**m	1
GUILLEM Francois	f**l@g**m	1
Titouan Robert	tr@d****r	1
olivroy	5****y	1
janusdebondt	j**t@g**m	1
etienne-s	2****s	1
boitardn	1****a	1

Committer Domains (Top 20 + Academic)

rte-france.com: 9 datak.fr: 1 gr0vsdma.rte-france.com: 1 pyre.datastorm.fr: 1 grovsw57.gr0vsdma.rte-france.com: 1 dreamrs.fr: 1 datastorm.fr: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 120
Total pull requests: 191
Average time to close issues: 11 months
Average time to close pull requests: 16 days
Total issue authors: 26
Total pull request authors: 18
Average comments per issue: 1.58
Average comments per pull request: 0.21
Merged pull requests: 163
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 1
Pull requests: 56
Average time to close issues: N/A
Average time to close pull requests: 8 days
Issue authors: 1
Pull request authors: 3
Average comments per issue: 0.0
Average comments per pull request: 0.13
Merged pull requests: 47
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

jalazawa (42)
FrancoisGuillem (19)
baptsegu (8)
pl-buiquang (6)
janusdebondt (5)
TitouanRobert (5)
hugo-antoine-rtei (4)
Maxxouxx (4)
pvictor (3)
payementcha (3)
jorritvm (3)
bthieurmel (2)
JulienBretteville (2)
MarionLi0 (2)
berthetclement (2)

Pull Request Authors

berthetclement (81)
KKamel67 (37)
jalazawa (26)
AssilMa (18)
etienne-s (15)
Nekmek7 (12)
TitouanRobert (10)
bthieurmel (6)
boitardn (4)
vargastat (2)
baptsegu (2)
pl-buiquang (2)
olivroy (2)
PPlessiez (1)
pvictor (1)

Top Labels

Issue Labels

bug (37) enhancement (29) feature (15) next_release (3) question (2) to discuss at the weekly point (1) rhdf5 (1) help wanted (1)

Pull Request Labels

bug (38) feature (23) enhancement (13) release_cran (9) release (5) documentation (4) next_release (3)

Packages

Total packages: 1
Total downloads:
- cran 770 last-month

Total dependent packages: 3
Total dependent repositories: 9
Total versions: 32
Total maintainers: 1

cran.r-project.org: antaresRead

Import, Manipulate and Explore the Results of an 'Antares' Simulation

Homepage: https://github.com/rte-antares-rpackage/antaresRead
Documentation: http://cran.r-project.org/web/packages/antaresRead/antaresRead.pdf
License: GPL-2 | GPL-3 | file LICENSE [expanded from: GPL (≥ 2) | file LICENSE]
Latest release: 2.9.0
published about 1 year ago

Versions: 32
Dependent Packages: 3
Dependent Repositories: 9
Downloads: 770 Last month

Rankings

Forks count: 9.7%

Dependent repos count: 9.9%

Dependent packages count: 10.6%

Average: 11.7%

Downloads: 12.3%

Stargazers count: 15.9%

Maintainers (1)

tatiana.vargas@rte-france.com

Last synced: 6 months ago

Dependencies

DESCRIPTION cran

bit64 * imports
data.table >= 1.9.6 imports
doParallel * imports
httr * imports
jsonlite * imports
lubridate >= 1.7.1 imports
methods * imports
pbapply * imports
plyr * imports
shiny * imports
stats * imports
stringr * imports
utils * imports
covr * suggests
foreach * suggests
htmltools * suggests
knitr * suggests
parallel * suggests
rhdf5 >= 2.24.0 suggests
rmarkdown * suggests
testthat * suggests

.github/workflows/R-CMD-check.yaml actions

actions/checkout v3 composite
r-lib/actions/check-r-package v2 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

.github/workflows/test-coverage.yaml actions

actions/checkout v3 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

antaresread

Science Score: 26.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

antaresRead

Installation

Initialisation

Read data from a simulation

Read synthetic results of all areas of a study with hourly time step.

Same but with a daily time step:

Read all Monte Carlo scenarios for a given area.

Same but add miscelaneous production time series to the result

Read only columns "LOAD" and "MRG. PRICE"

select areas containing "fr"

Same but remove areas containing "hvdc"

Get the links that connect two of the previous areas

Get the results for these areas and links

Work with the imported data

Select lines based on some criteria

Select columns, and compute new ones

Aggregate data by some variables

All three operations can be done with a single line of code

Contributing:

ANTARES :

License Information:

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

cran.r-project.org: antaresRead

Rankings

Maintainers (1)

Dependencies