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,
    PluginContext,
    Rule,
    System,
    apply_rules_to_context,
)
from r2x_plexos import PLEXOSParser, PLEXOSConfig

xml_path = /path/to/xml
db = PlexosDB.from_xml(xml_path)
model_names = db.list_objects_by_class(ClassEnum.Model)
model_name = model_names[1] if model_names else "Base"

plexos_config = PLEXOSConfig(
    model_name=model_name,
    horizon_year=2012,
    models=("r2x_plexos.models", "r2x_sienna.models"),)
data_file = DataFile(name="xml_file", fpath=xml_path)
store = DataStore(path=folder_path)
store.add_data([data_file])

context = PluginContext(
    config=plexos_config,
    store=store
)
parser = PLEXOSParser.from_context(context)
plexos_sys_result = parser.run()
plexos_sys = plexos_sys_result.system
context.source_system = plexos_sys

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

r2x_plexos-0.3.1.tar.gz (114.2 kB view details)

Uploaded Aug 11, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

r2x_plexos-0.3.1-py3-none-any.whl (131.9 kB view details)

Uploaded Aug 11, 2026 Python 3

File details

Details for the file r2x_plexos-0.3.1.tar.gz.

File metadata

Download URL: r2x_plexos-0.3.1.tar.gz
Upload date: Aug 11, 2026
Size: 114.2 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for r2x_plexos-0.3.1.tar.gz
Algorithm	Hash digest
SHA256	`7c55c9c149b76d87f9ef4bf118bc7692003f0f22cacbc29a7377c615dee57b9c`
MD5	`7dcfbb68cbe7fc760df309942780edf7`
BLAKE2b-256	`47f2d8fce80d14ee7316b318f73de756c57ebb7429507d4909a8fbece30770d4`

See more details on using hashes here.

Provenance

The following attestation bundles were made for r2x_plexos-0.3.1.tar.gz:

Publisher: release.yaml on NatLabRockies/r2x-plexos

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: r2x_plexos-0.3.1.tar.gz
- Subject digest: 7c55c9c149b76d87f9ef4bf118bc7692003f0f22cacbc29a7377c615dee57b9c
- Sigstore transparency entry: 2423372349
- Sigstore integration time: Aug 11, 2026
Source repository:
- Permalink: NatLabRockies/r2x-plexos@755ab54f450ec8b20ddd11b9e560a2fb67618b40
- Branch / Tag: refs/heads/main
- Owner: https://github.com/NatLabRockies
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yaml@755ab54f450ec8b20ddd11b9e560a2fb67618b40
- Trigger Event: push