NatLabRockies · pesap · Apr 16, 2025 · May 18, 2025 · Jun 13, 2025 · Jul 16, 2025
diff --git a/.gitignore b/.gitignore
@@ -58,6 +58,7 @@ coverage.xml
 # Django stuff:
 *.log
 local_settings.py
+_run_*_translations.py
 db.sqlite3
 db.sqlite3-journal
 

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,34 +1,57 @@
+default_stages:
+  - pre-commit
+
+default_install_hook_types:
+  - pre-commit
+  - commit-msg
+  - pre-push
+
 repos:
+  - repo: local
+    hooks:
+      - id: ruff-format
+        name: ruff format
+        entry: uv run ruff format --verbose
+        language: system
+        types_or: [python, pyi]
+
+      - id: ruff-check
+        name: ruff check
+        entry: uv run ruff check --fix --config=pyproject.toml packages/
+        language: system
+        types_or: [python, pyi]
+
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0 # Use the ref you want to point at
+    rev: v6.0.0
     hooks:
+      - id: end-of-file-fixer
       - id: trailing-whitespace
       - id: check-added-large-files
-        args: ["--maxkb=10000"]
-      - id: check-json
-      - id: pretty-format-json
-        args: ["--autofix"]
+      - id: check-merge-conflict
       - id: check-yaml
+      - id: check-toml
+      - id: check-json
       - id: check-case-conflict
-      - id: check-xml
-      - id: end-of-file-fixer
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v4.0.0-alpha.8"
-    hooks:
-      - id: prettier
-        types_or: [yaml]
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.9.3
+
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v4.10.0
     hooks:
-      - id: ruff
-        args: [--fix, --config=pyproject.toml]
-      - id: ruff-format
-        args: [--verbose]
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: "v1.11.0"
+      - id: commitizen
+        stages:
+          - commit-msg
+        pass_filenames: false
+
+  - repo: local
     hooks:
-      - id: mypy
+      - id: pytest
+        name: pytest (quick)
+        entry: uv run pytest -q -m "not slow" --maxfail=1 --disable-warnings
+        language: system
         types: [python]
-        args: [--config-file=pyproject.toml, ./src/r2x]
         pass_filenames: false
-        language: system
+        stages: [pre-push]
+
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.9.4
+    hooks:
+      - id: uv-lock
diff --git a/LICENCE.txt → LICENSE.txt b/LICENCE.txt → LICENSE.txt
diff --git a/README.md b/README.md
@@ -1,22 +1,16 @@
 ### R2X
+
 > Model translation parsing tool (ReEDS to X)
 >
-> [![image](https://img.shields.io/pypi/v/r2x.svg)](https://pypi.python.org/pypi/r2x)
-> [![image](https://img.shields.io/pypi/l/r2x.svg)](https://pypi.python.org/pypi/r2x)
-> [![image](https://img.shields.io/pypi/pyversions/r2x.svg)](https://pypi.python.org/pypi/r2x)
-> [![CI](https://github.com/NREL/r2x/actions/workflows/CI.yaml/badge.svg)](https://github.com/NREL/r2x/actions/workflows/CI.yaml)
-> [![codecov](https://codecov.io/gh/NREL/r2x/branch/main/graph/badge.svg)](https://codecov.io/gh/NREL/r2x)
-> [![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)
-> [![Documentation](https://github.com/NREL/R2X/actions/workflows/docs-build.yaml/badge.svg?branch=main)](https://nrel.github.io/R2X/)
-
+> [![image](https://img.shields.io/pypi/v/r2x.svg)](https://pypi.python.org/pypi/r2x) > [![image](https://img.shields.io/pypi/l/r2x.svg)](https://pypi.python.org/pypi/r2x) > [![image](https://img.shields.io/pypi/pyversions/r2x.svg)](https://pypi.python.org/pypi/r2x) > [![CI](https://github.com/NREL/r2x/actions/workflows/CI.yaml/badge.svg)](https://github.com/NREL/r2x/actions/workflows/CI.yaml) > [![codecov](https://codecov.io/gh/NREL/r2x/branch/main/graph/badge.svg)](https://codecov.io/gh/NREL/r2x) > [![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) > [![Documentation](https://github.com/NREL/R2X/actions/workflows/docs-build.yaml/badge.svg?branch=main)](https://nrel.github.io/R2X/)
 
 ## Table of contents
-* [Installation](#installation)
-* [Features](#features)
-* [Documentation](#documentation)
-* [Roadmap](#roadmap)
-* [Compatibility](#compatibility)
 
+- [Installation](#installation)
+- [Features](#features)
+- [Documentation](#documentation)
+- [Roadmap](#roadmap)
+- [Compatibility](#compatibility)
 
 ## Installation
 
@@ -32,18 +26,73 @@ Or use it as standalone tool,
 uvx r2x --help
 ```
 
+## Quick Start
+
+Use of Sienna parser.
+
+```python
+import json
+
+from r2x_sienna.config import SiennaConfig
+from r2x_sienna.parser import SiennaParser
+from r2x_sienna.upgrader.data_upgrader import SiennaUpgrader
+from r2x_core.logger import setup_logging
+from r2x_core.store import DataStore
+from r2x_core.upgrader_utils import run_upgrade_step
+
+# Use for debugging and see parser/exporter progress
+setup_logging(level="DEBUG")
+
+# Use for level info and store logging results to file
+setup_logging(level="INFO", log_file="debug.log")
+
+path_to_sys = "path/to/sienna_sys.json"
+
+# Required if upgrading a psy4 to psy5 system
+upgrader = SiennaUpgrader(path=path_to_sys)
+result = None
+with open(path_to_sys) as f:
+    loaded_sys = json.load(f)
+
+for step in upgrader.list_steps():
+    result = run_upgrade_step(step, data=loaded_sys, upgrader_context={"info": "value"})
+
+config = SiennaConfig(
+    model_year=2029,
+    system_name="Sienna System",
+    json_path=path_to_sys,
+    scenario="Base",
+    system_base_power=100.0,
+    skip_validation=False,
+)
+data_store = DataStore()
+parser = SiennaParser(
+    config=config,
+    data_store=data_store,
+    name=sys_name,
+    skip_validation=False,
+)
+stdin_payload = json.dumps(loaded_sys)
+sienna_sys = parser.build_system(stdin_payload=stdin_payload)
+```
+
+See the `examples/` directory for more usage patterns including validation, dry-run previews, and custom configuration.
+
 ## Features
 
+- Simple, functional API with Result[T, E] pattern
+- Validation before translation with helpful error messages
+- Dry-run mode to preview translations
+- I/O helpers for stdin/stdout workflows
 - [PowerSystem.jl](https://github.com/NREL-Sienna/PowerSystems.jl) model representations
-- Translate [ReEDS](https://github.com/NREL/ReEDS-2.0) models to PCM models like [Sienna](https://github.com/NREL-Sienna) or PLEXOS,
-- Translate from PLEXOS XML's to Sienna,
-- Comprehensive PLEXOS XML parser,
+- Translate [ReEDS](https://github.com/NREL/ReEDS-2.0) models to PCM models like [Sienna](https://github.com/NREL-Sienna) or PLEXOS
+- Translate from PLEXOS XML's to Sienna
+- Comprehensive PLEXOS XML parser
 
 ## Documentation
 
 R2X documentation is available at [https://nrel.github.io/R2X/](https://nrel.github.io/R2X/)
 
-
 ## Roadmap
 
 If you're curious about what we're working on, check out the roadmap:
@@ -53,14 +102,13 @@ If you're curious about what we're working on, check out the roadmap:
 - [Nice-to-have](https://github.com/NREL/R2X/labels/Optional): Nice to have features or Issues to fix. Anyone can start working on (please let us know before you do).
 - [Ideas](https://github.com/NREL/R2X/issues?q=is%3Aopen+is%3Aissue+label%3AIdea): Future work or ideas for R2X.
 
-
 ## Model compatibility
 
-| R2X Version  | Supported Input Model Versions           | Supported Output Model Versions          |
-|--------------|----------------------------------------- |----------------------------------------- |
-|     1.0      | ReEDS (v2024.8.0)                        | PLEXOS (9.0, 9.2, 10)                    |
-|              | Sienna (PSY 3.0)                         | Sienna (PSY 3.0, 4.0)                    |
-|              | PLEXOS (9.0, 9.2, 10)                    |                                          |
+| R2X Version | Supported Input Model Versions | Supported Output Model Versions |
+| ----------- | ------------------------------ | ------------------------------- |
+| 1.0         | ReEDS (v2024.8.0)              | PLEXOS (9.0, 9.2, 10)           |
+|             | Sienna (PSY 3.0)               | Sienna (PSY 3.0, 4.0)           |
+|             | PLEXOS (9.0, 9.2, 10)          |                                 |
 
 ### Licence
 

diff --git a/environment.yml b/environment.yml
diff --git a/packages/r2x-plexos-to-sienna/README.md b/packages/r2x-plexos-to-sienna/README.md
@@ -0,0 +1,43 @@
+# R2X PLEXOS to Sienna Translator
+
+This package provides translation capabilities from PLEXOS XML database files to Sienna PowerSystems format.
+
+## Usage
+
+### Basic Translation
+
+```python
+from r2x_plexos_to_sienna import PlexosToSiennaTranslation
+from r2x_core.logger import setup_logging
+
+# Advanced logging
+# setup_logging(
+#     level="DEBUG",
+#     fmt="<green>{time:YYYY-MM-DD HH:mm:ss}</green> <level>{extra[short_level]:<4}</level> {message}",
+#     log_file="debug.log"
+# )
+
+# Define input file
+xml_path = "/path/to/xml"
+
+# Step to extract desired model name (important to locate time series, otherwise sets a default)
+#
+db = PlexosDB.from_xml(xml_path)
+model_names = db.list_objects_by_class(ClassEnum.Model)
+
+# Create translator instance
+translator = PlexosToSiennaTranslation(
+    xml_path=xml_path,
+    model_name=model_names[1] if model_names else "Base", # model_2012
+)
+# Run the translation
+translator.run()
+```
+
+## Configuration
+
+The translator uses configuration rules defined in `config/rules.json` to map PLEXOS objects to Sienna PowerSystems components.
+
+## Output
+
+The translation produces Sienna PowerSystems-compatible JSON files in the specified output directory.
diff --git a/packages/r2x-plexos-to-sienna/pyproject.toml b/packages/r2x-plexos-to-sienna/pyproject.toml
@@ -0,0 +1,12 @@
+[project]
+name = "r2x-plexos-to-sienna"
+version = "0.0.0"
+description = "Translation helpers for PLEXOS-to-Sienna interoperability."
+requires-python = ">=3.11, <3.14"
+dependencies = ["r2x-plexos>=0.1.2,<1.0.0", "r2x-sienna>=0.1.0,<1.0.0"]
+
+[project.entry-points."r2x_plugin"]
+plexos-to-sienna = "r2x_plexos_to_sienna.plugin:manifest"
+
+[tool.setuptools.package-data]
+r2x_plexos_to_sienna = ["config/*.json"]
diff --git a/packages/r2x-plexos-to-sienna/src/r2x_plexos_to_sienna/__init__.py b/packages/r2x-plexos-to-sienna/src/r2x_plexos_to_sienna/__init__.py
@@ -0,0 +1,26 @@
+"""R2X PLEXOS to Sienna Translation Plugin.
+
+A plugin for translating PLEXOS model systems to Sienna format within the R2X framework.
+"""
+
+from importlib.metadata import version
+
+from loguru import logger
+
+from .getters import *  # noqa: F403
+from .plugin_config import PlexosToSiennaConfig
+
+__version__ = version("r2x_plexos_to_sienna")
+
+
+logger.disable("r2x_plexos_to_sienna")
+
+
+__all__ = [
+    "PlexosToSiennaConfig",
+    "__version__",
+]
+
+
+def hello() -> str:
+    return "Hello from r2x-plexos-to-sienna!"
diff --git a/packages/r2x-plexos-to-sienna/src/r2x_plexos_to_sienna/config/defaults.json b/packages/r2x-plexos-to-sienna/src/r2x_plexos_to_sienna/config/defaults.json
@@ -0,0 +1,43 @@
+{
+    "prime_mover_types": {
+        "battery": "BA",
+        "caes": "CE",
+        "coal": "ST",
+        "gas-cc": "CC",
+        "gas-ct": "GT",
+        "lfill-gas": "GT",
+        "nuclear": "ST",
+        "o-g-s": "ST",
+        "biopower": "ST",
+        "beccs": "ST",
+        "hyd": "HY",
+        "hydud": "HY",
+        "hydund": "HY",
+        "hyded": "HY",
+        "hydend": "HY",
+        "hydnd": "HY",
+        "hydnpnd": "HY",
+        "hydsnd": "HY",
+        "hydro-d": "HY",
+        "can-imports": "HY",
+        "hydro-and": "HY",
+        "hydro-dispatch": "HY",
+        "pumped-hydro": "PS",
+        "upv": "PVe",
+        "distpv": "PVe",
+        "dupv": "PVe",
+        "csp": "CP",
+        "pvb": "PVe",
+        "wind-ons": "WT",
+        "wind-ofs": "WS",
+        "geothermal": "BT",
+        "geohydro": "BT",
+        "egs": "BT",
+        "egs-nearfield": "BT",
+        "rtes": "BT",
+        "smr": "FC",
+        "h2-ct": "GT",
+        "h2-cc": "CC",
+        "electrolyzer": "OT"
+    }
+}