r2x-plexos

R2X plug-in for translating to and from PLEXOS XML databases.

R2X PLEXOS plugin for parsing and exporting PLEXOS power system models.

Quick Start

Installation

uv add r2x-plexos

Parsing PLEXOS XML

from pathlib import Path
from r2x_core import DataFile, DataStore
from r2x_plexos import PLEXOSParser, PLEXOSConfig

# Parse PLEXOS XML
config = PLEXOSConfig(model_name="Base", reference_year=2024)
store = DataStore(path=Path("data"))
store.add_data(DataFile(name="xml_file", glob="*.xml"))

parser = PLEXOSParser(config, store)
system = parser.build_system()

Documentation Sections

• Tutorials - Step-by-step learning guides
• How-To Guides - Task-focused recipes
• Explanations - Architecture and design
• References - API and configuration reference

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 Core.