antaresRead

Import, manipulate and explore the results of an Antares simulation.
https://github.com/rte-antares-rpackage/antaresread

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

Last synced: about 24 hours ago
JSON representation

Repository metadata

Import, manipulate and explore the results of an Antares simulation

• Host: GitHub
• URL: https://github.com/rte-antares-rpackage/antaresread
• Owner: rte-antares-rpackage
• Created: 2016-11-15T15:26:32.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-04-30T13:06:36.000Z (12 days ago)
• Last Synced: 2024-05-01T03:42:29.314Z (11 days ago)
• Topics: adequacy, bilan, electricity, energy, hdf5, linear-algebra, monte-carlo-simulation, optimisation, previsionnel, r, rhdf5, rte, simulation, tyndp
• Language: R
• Homepage: https://rte-antares-rpackage.github.io/antaresRead/
• Size: 67.6 MB
• Stars: 11
• Watchers: 7
• Forks: 6
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

README

        





# antaresRead

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

[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/antaresRead)](https://cran.r-project.org/package=antaresRead)

[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

[![R-CMD-check](https://github.com/rte-antares-rpackage/antaresRead/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rte-antares-rpackage/antaresRead/actions/workflows/R-CMD-check.yaml)

[![Codecov test coverage](https://codecov.io/gh/rte-antares-rpackage/antaresRead/branch/master/graph/badge.svg)](https://app.codecov.io/gh/rte-antares-rpackage/antaresRead?branch=master)

## 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/cheat_sheet/antares_cheat_sheet_en.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)

```

You must also change the h5 file [here](https://github.com/rte-antares-rpackage/antaresRead/blob/master/tests/testthat/helper_init.R#L35).

## ANTARES :

 Antares is a powerful software developed by RTE to simulate and study electric power systems (more information about Antares here : ).

 

ANTARES is now an open-source project (since 2018), you can download the sources [here](https://github.com/AntaresSimulatorTeam/Antares_Simulator) if you want to use this package. 

## License Information:

Copyright 2015-2016 RTE (France)

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

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

      

---

Owner metadata

• Name: rte-antares-rpackage
• Login: rte-antares-rpackage
• Email: [email protected]
• Kind: organization
• Description: RTE ANTARES R PACKAGE
• Website: https://rte-antares-rpackage.github.io/rPackagesRte/
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/23478907?v=4
• Repositories: 30
• Last ynced at: 2024-04-14T20:00:08.206Z
• Profile URL: https://github.com/rte-antares-rpackage

---

GitHub Events

Total

• Create event: 133
• Release event: 16
• Issues event: 176
• Watch event: 10
• Delete event: 94
• Member event: 8
• Issue comment event: 168
• Push event: 626
• Pull request review comment event: 1
• Pull request review event: 8
• Pull request event: 209
• Fork event: 17

Last Year

• Create event: 45
• Delete event: 32
• Fork event: 1
• Issue comment event: 5
• Pull request event: 65
• Pull request review comment event: 1
• Pull request review event: 6
• Push event: 110
• Release event: 1

---

Committers metadata

Last synced: 2 days ago

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
Etienne	e****z@d****r	18
Clément Berthet	c****3@g****m	17
AssilMa	4****a	15
MANSOURI Assil Ext	a****i@r****m	13
unknown	j****a@G****m	6
Mahabd	1****7	4
Benoit Thieurmel	b****l@p****r	3
Baptiste	b****t@r****m	3
Paul Bui-Quang	p****g@r****m	3
PPlessiez	p****z@r****m	3
KKamel67	5****7	1
boitardn	1****a	1
etienne-s	2****s	1
janusdebondt	j****t@g****m	1
olivroy	5****y	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	t****r@d****r	1

Committer domains:

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

---

Issue and Pull Request metadata

Last synced: 2 days ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/rte-antares-rpackage/antaresread

---

---

---

Package metadata

• Total packages: 1
• Total downloads:
  • cran: 1,187 last-month
• Total dependent packages: 3
• Total dependent repositories: 9
• Total versions: 28
• Total maintainers: 1

---

Dependencies

Score: 13.399995114002609