r2x-plexos

PLEXOS models, parser, and exporter for the R2X ecosystem.

r2x-plexos reads PLEXOS XML into typed R2X systems and exports systems back to PLEXOS. Use r2x-cli for repeatable pipelines and R2X translation plugins for cross-format mappings.

Quick Start

Use Python 3.11, 3.12, or 3.13. In your active Python environment:

python -m pip install r2x-plexos
python -c "import r2x_plexos; print(r2x_plexos.__version__)"

The command prints the installed package version. For the separately installed CLI, install into its managed environment:

r2x python install
r2x install r2x-plexos
r2x list r2x-plexos

Confirm plexos-parser and plexos-exporter are discovered, then follow the round-trip tutorial.

Documentation

• Getting started: installation, environment setup, and first-use checks.
• Tutorials: parse and export a public test model.
• How-to guides: Python contexts and CLI pipelines.
• Reference / API: exports, configuration, and source links.
• Explanation: data flow and compatibility.
• Troubleshooting: discovery, inputs, and export failures.
• Changelog: canonical release history.
• Contributors: development and docs checks.

Development

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

See docs/README.md for the documentation build.

License

BSD-3-Clause. See LICENSE.txt.