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

Edit an Antares study
https://github.com/rte-antares-rpackage/antareseditobject

antares-simulation cluster energy monte-carlo-simulation r rte

Last synced: 3 days ago
JSON representation

Edit an Antares study

• Host: GitHub
• URL: https://github.com/rte-antares-rpackage/antareseditobject
• Owner: rte-antares-rpackage
• Created: 2017-07-06T13:07:19.000Z (about 7 years ago)
• Default Branch: develop
• Last Pushed: 2024-04-12T15:01:19.000Z (6 months ago)
• Last Synced: 2024-04-14T05:10:14.857Z (6 months ago)
• Topics: antares-simulation, cluster, energy, monte-carlo-simulation, r, rte
• Language: R
• Homepage: https://rte-antares-rpackage.github.io/antaresEditObject/
• Size: 1.89 MB
• Stars: 8
• Watchers: 5
• Forks: 6
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        





# antaresEditObject

> Edit an Antares study before running a simulation.

[![CRAN status](https://www.r-pkg.org/badges/version/antaresEditObject)](https://CRAN.R-project.org/package=antaresEditObject)

[![cranlogs](https://cranlogs.r-pkg.org/badges/antaresEditObject)](https://cran.r-project.org/package=antaresEditObject)

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)

[![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/antaresEditObject/workflows/R-CMD-check/badge.svg)](https://github.com/rte-antares-rpackage/antaresEditObject/actions)

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

## Installation

Install from CRAN:

```r

install.packages("antaresEditObject")

```

Or install dev version from GitHub:

```r

remotes::install_github("rte-antares-rpackage/antaresEditObject", build_vignettes = TRUE)

```

## Goal

This package allows to edit an Antares study. Methods are provided to create

(and remove) areas, links between them, thermal clusters and binding

constraints. These steps may be useful before running an Antares simulation.

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

## Usage

Usage of the package is detailed in the vignette: `vignette("antaresEditObject")`.