R2X

Translation plugins for ReEDS, PLEXOS, and Sienna.

R2X maps parsed power-system components and time series into a target model. The r2x-cli manages plugins and runs pipelines. r2x-core supplies the shared system, configuration, and rule APIs.

Quick Start

Install r2x-cli and Python 3.11, 3.12, or 3.13. Install the translation plugin for your workflow:

r2x install r2x-reeds-to-plexos

The CLI installs the plugin and its dependencies into its managed environment. To manage your own Python environment instead:

python -m pip install r2x-reeds-to-plexos

Documentation

Use the guide that matches your task:

• Getting started: run and inspect your first pipeline.
• Translation workflows: parse, translate, and export a model.
• Property reference: inspect mappings and their source rules.
• Architecture: understand package boundaries.
• Development: run checks and maintain translations.

The site includes searchable current documentation and release archives.

Translation Plugins

Package	Direction
r2x-reeds-to-plexos	ReEDS → PLEXOS
r2x-reeds-to-sienna	ReEDS → Sienna
r2x-plexos-to-sienna	PLEXOS → Sienna
r2x-sienna-to-plexos	Sienna → PLEXOS

Development

From the repository root, install the development environment and run its checks:

uv sync && uv run prek run --all-files --hook-stage pre-push

See Development for focused checks and the documentation README for the site build.

License

BSD-3-Clause. See LICENSE.txt.