Installation

The only pre-requisite to install r2x-reeds is Python 3.11 or greater.

Python version support

Python 3.11, 3.12, 3.13.

Installation options

R2X ReEDS 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-reeds

# Or add to a project
uv add r2x-reeds

Installation with pip

# Install system-wide
pip install r2x-reeds

# Or in a virtual environment
python -m pip install r2x-reeds

Upgrading options

Upgrading with uv

uv pip install --upgrade r2x-reeds

Upgrading with pip

python -m pip install --upgrade r2x-reeds

Verify installation

Check that R2X ReEDS is installed correctly:

import r2x_reeds
print(f"R2X ReEDS version: {r2x_reeds.__version__}")

Next steps

See the how-to guides for practical usage examples or check out the API documentation for detailed reference information.