[!WARNING] This project is currently optimized for internal R2X workflows. You are welcome to use it, but APIs and behavior may continue to evolve as
r2x-coreevolves.
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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file r2x_reeds-0.8.0.tar.gz.
File metadata
- Download URL: r2x_reeds-0.8.0.tar.gz
- Upload date:
- Size: 74.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f32d027d6e3159b91f4b118a9cb7cce1d27c297c91c8d51bf7fb608307224960
|
|
| MD5 |
5d0e8d3ddbf66894958cbc6cbba87d6c
|
|
| BLAKE2b-256 |
05762cbd911f08fa85e9e001dbbc7fd2d9dd68a6f6f7b26a480c4d78454eec9f
|
Provenance
The following attestation bundles were made for r2x_reeds-0.8.0.tar.gz:
Publisher:
release.yaml on NatLabRockies/r2x-reeds
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
r2x_reeds-0.8.0.tar.gz -
Subject digest:
f32d027d6e3159b91f4b118a9cb7cce1d27c297c91c8d51bf7fb608307224960 - Sigstore transparency entry: 2568148195
- Sigstore integration time:
-
Permalink:
NatLabRockies/r2x-reeds@27aaf400378b38d2daf50717fed1b80637f28d0d -
Branch / Tag:
refs/heads/main - Owner: https://github.com/NatLabRockies
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@27aaf400378b38d2daf50717fed1b80637f28d0d -
Trigger Event:
push
-
Statement type:
File details
Details for the file r2x_reeds-0.8.0-py3-none-any.whl.
File metadata
- Download URL: r2x_reeds-0.8.0-py3-none-any.whl
- Upload date:
- Size: 89.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d2f73f17936ace794731cf4e77bfdd875cda43169f1671f2769dafa2af63a079
|
|
| MD5 |
4f192a27ae749e719094374fb69f5a71
|
|
| BLAKE2b-256 |
ffb7af529fcdeac3f87f8c40e41dff937a26421293fb049eab8446f3718fc4ff
|
Provenance
The following attestation bundles were made for r2x_reeds-0.8.0-py3-none-any.whl:
Publisher:
release.yaml on NatLabRockies/r2x-reeds
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
r2x_reeds-0.8.0-py3-none-any.whl -
Subject digest:
d2f73f17936ace794731cf4e77bfdd875cda43169f1671f2769dafa2af63a079 - Sigstore transparency entry: 2568148198
- Sigstore integration time:
-
Permalink:
NatLabRockies/r2x-reeds@27aaf400378b38d2daf50717fed1b80637f28d0d -
Branch / Tag:
refs/heads/main - Owner: https://github.com/NatLabRockies
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@27aaf400378b38d2daf50717fed1b80637f28d0d -
Trigger Event:
push
-
Statement type:
