Metadata-Version: 2.3
Name: r2x-reeds
Version: 0.4.0
Summary: ReEDS model plugin
Keywords: ReEDS
Author: pesap, kodiobika, mcllerena
Author-email: pesap <pesap@users.noreply.github.com>, kodiobika <kodiobika@users.noreply.github.com>, mcllerena <mcllerena@users.noreply.github.com>
License: BSD 3-Clause License
         
         Copyright (c) 2025, Alliance for Sustainable Energy LLC, All rights reserved.
         
         Redistribution and use in source and binary forms, with or without
         modification, are permitted provided that the following conditions are met:
         
         1. Redistributions of source code must retain the above copyright notice, this
            list of conditions and the following disclaimer.
         
         2. Redistributions in binary form must reproduce the above copyright notice,
            this list of conditions and the following disclaimer in the documentation
            and/or other materials provided with the distribution.
         
         3. Neither the name of the copyright holder nor the names of its
            contributors may be used to endorse or promote products derived from
            this software without specific prior written permission.
         
         THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
         AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
         IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
         DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
         FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
         DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
         SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
         CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
         OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
         OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Topic :: Software Development :: Build Tools
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Topic :: File Formats :: JSON
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Dist: r2x-core>=0.4.1,<1.0.0
Maintainer: pesap, kodiobika, mcllerena
Maintainer-email: pesap <pesap@users.noreply.github.com>, kodiobika <kodiobika@users.noreply.github.com>, mcllerena <mcllerena@users.noreply.github.com>
Requires-Python: >=3.11, <3.14
Description-Content-Type: text/markdown

### r2x-reeds
> R2X Core plugin for translating ReEDS power system models
>
> [![image](https://img.shields.io/pypi/v/r2x-reeds.svg)](https://pypi.python.org/pypi/r2x-reeds)
> ![PyPI - License](https://img.shields.io/pypi/l/r2x-reeds)
> ![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FNREL%2Fr2x-reeds%2Frefs%2Fheads%2Fmain%2Fpyproject.toml)
> [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
> [![codecov](https://codecov.io/gh/NREL/r2x-reeds/branch/main/graph/badge.svg)](https://codecov.io/gh/NREL/r2x-reeds)
> [![Documentation](https://github.com/NREL/r2x-reeds/actions/workflows/docs.yaml/badge.svg?branch=main)](https://nrel.github.io/r2x-reeds/)
> [![Docstring Coverage](https://nrel.github.io/r2x-reeds/_static/docstr_coverage_badge.svg)](https://nrel.github.io/r2x-reeds/)

R2X ReEDS is an [R2X Core](https://github.com/NREL/r2x-core) plugin for parsing [Regional Energy Deployment System (ReEDS)](https://github.com/NREL/ReEDS-2.0) power system model data. It provides a comprehensive parser for NREL's ReEDS model, enabling seamless data exchange with other power system modeling platforms through the R2X Core framework.

## Features

- Read ReEDS inputs and outputs from multiple file formats including CSV and HDF5
- Automatic component mapping for generators, regions, transmission lines, reserves, and emissions data
- Time series support for capacity factors, load profiles, and reserve requirements
- Pattern-based technology categorization to automatically handle different technology variants and naming conventions
- JSON-based configuration through defaults and file mapping specifications
- Built-in validation against actual data files to ensure data integrity

## Quick Start

```console
pip install r2x-reeds
```

```python
from r2x_reeds import ReEDSParser, ReEDSConfig, ReEDSGenerator
from r2x_core import DataStore, PluginContext

# Configure
config = ReEDSConfig(
    solve_year=2030,
    weather_year=2012,
    case_name="test_Pacific"
)

# Create data store
run_path = "path/to/reeds_folder/"
store = DataStore.from_plugin_config(config, path=run_path)

# Create plugin context and run parser
ctx = PluginContext(config=config, store=store)
parser = ReEDSParser.from_context(ctx)
ctx = parser.run()

# Access system and components
system = ctx.system
generators = list(system.get_components(ReEDSGenerator))
print(f"Built system with {len(generators)} generators")
```

## Supported Components

- Solar generators including utility-scale photovoltaic, distributed photovoltaic, concentrating solar power, and photovoltaic with battery storage
- Wind generators for both onshore and offshore installations
- Thermal generation including coal, natural gas combined cycle and combustion turbine units, and nuclear power plants
- Hydroelectric facilities and energy storage systems
- Regional components modeled at the balancing authority level with transmission region hierarchies
- Transmission interfaces and lines with bidirectional capacity representation
- Reserve requirements by type including spinning reserves, regulation reserves, and flexibility reserves organized by region
- Demand profiles representing load by region over time
- Emission data including carbon dioxide and nitrogen oxide emission rates for each generator

## Documentation

- [Installation Guide](docs/source/install.md) - Installation instructions
- [Configuration Reference](docs/source/references/configuration.md) - Configuration options and defaults
- [API Reference](docs/source/references/api.md) - Complete API documentation
- [Parser Reference](docs/source/references/parser.md) - Parser implementation details
- [Models Reference](docs/source/references/models.md) - Component model documentation
- [R2X Core Documentation](https://github.com/NREL/r2x-core) - Core framework documentation
