Skip to content

NREL/R2X

Repository files navigation

SWC

R2X

Model translation parsing tool (ReEDS to X)

image image image CI codecov Ruff Documentation




Table of contents

Quick Start

Prerequisites

mamba env create -f environment.yml && conda activate r2x

To install all Python dependencies

python -m pip install -e  ".[all]"

Running the CLI

r2x -i $RUN_FOLDER --year=2035 -o $OUTPUT_FOLDER

Developer environment setup

Before starting to work on adding/fixing on R2X, make sure that you setup your environment to include all the developer dependencies and our opinionated pre-commit hooks.

python -m pip install -e ".[dev]"

Install pre-commit hooks

pre-commit install

Roadmap

If you're curious about what we're working on, check out the roadmap:

  • Active issues: Issues that we are actively working on.
  • Prioritized backlog: Issues we'll be working on next.
  • Nice-to-have: Nice to have features or Issues to fix. Anyone can start working on (please let us know before you do).
  • Ideas: Future work or ideas for R2X.

Compatibility

R2X Version Supported Input Model Versions Supported Output Model Versions
0.1 ReEDS (v1, v2, v3, v4) Plexos 9.000R6
0.2 Sienna (PowerSystem 1.0) Nodal Sienna
ReEDS Plexos 9.000R6, 9.2000R5
Plexos Nodal Plexos
0.3 Sienna (PowerSystem 1.0) Nodal Sienna
Sienna (PowerSystem 1.0)* Plexos s 9.000R6, 9.2000R5
ReEDS Plexos 9.000R6, 9.2000R5
Plexos Nodal Plexos

Notes:

  • Sienna to Plexos: Experimental phase