Installation

Install the published r2x-plexos package for your workflow. It supports Python 3.11, 3.12, and 3.13 according to package metadata. Use environment setup first if you need a Python environment or the r2x executable.

Use the Python library

With your supported Python environment activated:

python -m pip install r2x-plexos

This installs the format package and its dependencies, including r2x-core and Infrasys. The PLEXOS XML database interface is supplied by plexosdb. Published distributions and their Python requirements are on PyPI.

Use the CLI plugin

After installing r2x-cli and preparing its managed runtime:

r2x install r2x-plexos

The CLI installs into its own managed environment. A package installed with pip in another environment is not automatically available to the CLI. You only need to follow both installation routes when using both environments.

Continue with verify installation and first use. For an existing artifact, compare its writer’s package versions with release source before changing dependencies.

Develop the package

Source checkouts, uv sync, tests and documentation authoring belong to the separate contributor guide. A source checkout is not required for normal package installation or the downloaded-fixture tutorial.