Installation¶
The only pre-requisite to install r2x-plexos is Python 3.11 or greater.
Python version support¶
Python 3.11, 3.12, 3.13.
Installation options¶
R2X PLEXOS is available to install on PyPI and can be installed using any python package manager of your preference, but we recommend using uv.
Installation with uv¶
# Install as a tool
uv tool install r2x-plexos
# Or add to a project
uv add r2x-plexos
Installation with pip¶
# Install system-wide
pip install r2x-plexos
# Or in a virtual environment
python -m pip install r2x-plexos
Upgrading options¶
Upgrading with uv¶
uv pip install --upgrade r2x-plexos
Upgrading with pip¶
python -m pip install --upgrade r2x-plexos
Verify installation¶
Check that R2X PLEXOS is installed correctly:
import r2x_plexos
print(f"R2X PLEXOS version: {r2x_plexos.__version__}")
Next steps¶
Tutorials - Step-by-step learning guides
How-To Guides - Task-focused recipes
API Reference - Complete API documentation