r2x-reeds integrates NREL ReEDS model data
with r2x-core and infrasys. It provides a parser plugin for building
infrasys.System objects from ReEDS data, plus a set of reusable post-parse
transforms for common system-modification workflows.
Quickstart · Installation · What It Provides · Usage with r2x-core · Development · License
Quickstart
Install:
pip install r2x-reeds
Parse a ReEDS run directory into an infrasys.System:
from pathlib import Path
from r2x_core import DataStore, PluginContext
from r2x_reeds import ReEDSConfig, ReEDSParser
run_path = Path("path/to/reeds_run")
config = ReEDSConfig(
solve_year=2030,
weather_year=2012,
case_name="test_Pacific",
)
ctx = PluginContext(
config=config,
store=DataStore.from_plugin_config(config, path=run_path),
)
system = ReEDSParser.from_context(ctx).run().system
print(system.name)
Installation
From PyPI
Python requirement: >=3.11, <3.14.
pip install r2x-reeds
Using uv:
uv add r2x-reeds
From Source
git clone https://github.com/NREL/r2x-reeds.git
cd r2x-reeds
uv sync --all-groups
What It Provides
ReEDSParser: reads ReEDS outputs and inputs (CSV/HDF5-backed mappings) intoinfrasys.Systemcomponents and time series.ReEDSUpgraderandrun_reeds_upgrades(...): input version-detection and upgrade pipeline run during parser lifecycle.- Plugin entry point for
r2x-coreunder ther2x_plugingroup:reeds-parser = r2x_reeds:ReEDSParser
- Transform entry points under
r2x.transforms:add-pcm-defaultsadd-emission-capadd-electrolyzer-loadadd-purchaser-loadadd-ccs-creditbreak-gensadd-importsadd-optimal-siting
Usage with r2x-core
r2x-reeds follows the r2x-core plugin lifecycle.
- Build parser instances with
PluginContext. - Run lifecycle hooks with
.run(). - Configure parsing through
ReEDSConfig. - Apply optional
r2x.transformsafter parsing for scenario/system modifiers.
Development
Install dev dependencies:
uv sync --all-groups
Run the same checks used in CI:
uv run prek run --all-files --hook-stage pre-push
Targeted commands:
uv run pytest -q -m "not slow" --maxfail=1 --disable-warnings
uv run ty check ./src/r2x_reeds/
License
BSD 3-Clause. See LICENSE.txt.
1 maintainer
Metadata
1 maintainer
Release files for r2x-reeds 0.9.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| r2x_reeds-0.9.0.tar.gz | 75.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| r2x_reeds-0.9.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 165.8 kB
Release files / r2x_reeds-0.9.0.tar.gz
| Download URL | r2x_reeds-0.9.0.tar.gz |
|---|---|
| Size | 75.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
13441890f6574f6d6dd79110608bac3749227766959ef3988b29df26dc427530
|
|
BLAKE2b-256 checksum How to use checksums |
a4c0190cf4592f1d62b1d2a9078ef4da1ea7b3622671be15e09d5ee47d26776d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.
Transparency logRelease files / r2x_reeds-0.9.0-py3-none-any.whl
| Download URL | r2x_reeds-0.9.0-py3-none-any.whl |
|---|---|
| Size | 90.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7f1a980331046b423dae16e69ef1d42ea3ddd0846b3f18483fa571263af6c38b
|
|
BLAKE2b-256 checksum How to use checksums |
2d82bf3707736b03bc9ff6d076cc68446c0b1c5fd024471e4ae4ade65c017dbf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.
Transparency log
