Skip to content

Plugins and workflow

r2x-plexos provides two registered plugins. Start with the pip installation for Python applications, or install the package in the separate r2x-cli environment for pipelines.

Registered namePublic classRole
plexos-parserPLEXOSParserRead native input and populate the context System.
plexos-exporterPLEXOSExporterConsume a System and write native output.

This is the complete r2x_plugin registration table. There are no system modifiers registered by this package. Do not expect a model class or an upgrade helper to appear as a CLI plugin.

The parser reads native XML and profile references into PLEXOS components. The exporter consumes those components and writes native XML and profile CSVs. A parser/exporter round trip preserves a format; translating to another format needs a separate mapping plugin.

flowchart LR
  Input[Native input] --> Parser[plexos-parser]
  Parser --> System[Typed System]
  System --> Exporter[plexos-exporter]
  Exporter --> Output[Native output]
  System --> Archive[Portable archive for inspection]

Verify discovery in the runtime where you installed the package:

Terminal window
r2x list r2x-plexos

Expect both names in the table. Inspect their actual installed options before creating a pipeline:

Terminal window
r2x run plexos-parser --help
r2x run plexos-exporter --help

Use the round-trip tutorial to download pinned public inputs, parse them, check component counts, export, and inspect an archive. Use Python contexts when your application needs analysis between steps. The Core lifecycle explains how contexts carry configuration and systems.

For cross-format workflows, use the separate R2X translation plugins and the destination model package. r2x-reeds supplies ReEDS parsing and system modifiers; those registrations are not part of r2x-plexos.