R2X documentation

This repository contains the interoperability layer in the r2x-cli ecosystem. It connects model-specific parsers and exporters through shared r2x-core systems, rules, plugins, data stores, and units.

Start here

• Getting started explains installation and how to choose an interoperability workflow.
• Translation workflows contains contributor-oriented, end-to-end interoperability examples.
• Architecture explains the parser, interoperability, and exporter boundaries.
• Development covers repository checks and changes to interoperability packages.

Translation plugins

ReEDS translates to either PLEXOS or Sienna. PLEXOS and Sienna also translate to each other through separate plugins. The arrows show supported directions; there is no translation back to ReEDS.

flowchart LR
  accTitle: Supported model translations
  accDescr: ReEDS to PLEXOS, ReEDS to Sienna, PLEXOS to Sienna, and Sienna to PLEXOS. No reverse ReEDS translation is provided.
  R["ReEDS"] --> P["PLEXOS"]
  R --> S["Sienna"]
  P --> S
  S --> P
  class R source
  class P,S target
  classDef source fill:#d9effa,stroke:#0079c2,color:#003a69,stroke-width:2px
  classDef target fill:#003a69,stroke:#0079c2,color:#ffffff,stroke-width:2px

Follow each package’s PyPI link for its latest release and registry information. Match parser and exporter dependencies before upgrading.

Package	Release	Direction
r2x-reeds-to-plexos	Latest release	ReEDS → PLEXOS · properties
r2x-reeds-to-sienna	Latest release	ReEDS → Sienna · properties
r2x-plexos-to-sienna	Latest release	PLEXOS → Sienna · properties
r2x-sienna-to-plexos	Latest release	Sienna → PLEXOS · properties

Compatibility

Use parser and exporter versions compatible with the translation package. Each workflow lists its required packages. Historical compatibility information is available in the release archives selected from the version menu.

See architecture for ecosystem boundaries and open issues for planned work.