r2x-plexos 0.1.0__tar.gz

r2x_plexos-0.1.0/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.3
+Name: r2x-plexos
+Version: 0.1.0
+Summary: Plexos Models, Parser and Exporter
+Keywords: PLEXOS
+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: plexosdb>=1.1.3
+Requires-Dist: r2x-core>=0.1.1,<1.0.0
+Requires-Python: >=3.11, <3.14
+Project-URL: Changelog, https://nrel.github.io/r2x-plexos/CHANGELOG.html
+Project-URL: Documentation, https://nrel.github.io/r2x-plexos/
+Project-URL: Homepage, https://github.com/NREL/r2x-plexos
+Project-URL: Issues, https://github.com/NREL/r2x-plexos/issues
+Project-URL: Repository, https://github.com/NREL/r2x-plexos
+Description-Content-Type: text/markdown
+
+# r2x-plexos
+
+> R2X plug-in for translating to and from PLEXOS XML databases.
+>
+> [![image](https://img.shields.io/pypi/v/r2x.svg)](https://pypi.python.org/pypi/r2x-plexos)
+> [![image](https://img.shields.io/pypi/l/r2x.svg)](https://pypi.python.org/pypi/r2x-plexos)
+> [![image](https://img.shields.io/pypi/pyversions/r2x.svg)](https://pypi.python.org/pypi/r2x-plexos)
+> [![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-plexos/branch/main/graph/badge.svg)](https://codecov.io/gh/NREL/r2x-plexos)
+> [![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-plexos/actions/workflows/docs.yaml/badge.svg?branch=main)](https://nrel.github.io/r2x-plexos/)
+> [![Docstring Coverage](https://nrel.github.io/r2x-plexos/_static/docstr_coverage_badge.svg)](https://nrel.github.io/r2x-plexos/)
+
+
+R2X PLEXOS plugin for parsing and exporting PLEXOS power system models.
+
+## Quick Start
+
+### Installation
+
+```bash
+uv add r2x-plexos
+```
+
+### Parsing PLEXOS XML
+
+```python
+from pathlib import Path
+from r2x_core import DataFile, DataStore
+from r2x_plexos import PLEXOSParser, PLEXOSConfig
+
+# Parse PLEXOS XML
+config = PLEXOSConfig(model_name="Base", reference_year=2024)
+store = DataStore(path=Path("data"))
+store.add_data(DataFile(name="xml_file", glob="*.xml"))
+
+parser = PLEXOSParser(config, store)
+system = parser.build_system()
+```
+
+## Documentation Sections
+
+- [Tutorials](https://nrel.github.io/r2x-plexos/tutorials/) - Step-by-step learning guides
+- [How-To Guides](https://nrel.github.io/r2x-plexos/how-tos/) - Task-focused recipes
+- [Explanations](https://nrel.github.io/r2x-plexos/explanations/) - Architecture and design
+- [References](https://nrel.github.io/r2x-plexos/explanations/references/) - API and configuration reference
+
+## Roadmap
+
+If you're curious about what we're working on, check out the roadmap:
+
+- [Active issues](https://github.com/NREL/r2x-core/issues?q=is%3Aopen+is%3Aissue+label%3A%22Working+on+it+%F0%9F%92%AA%22+sort%3Aupdated-asc): Issues that we are actively working on.
+- [Prioritized backlog](https://github.com/NREL/r2x-core/issues?q=is%3Aopen+is%3Aissue+label%3ABacklog): Issues we'll be working on next.
+- [Nice-to-have](https://github.com/NREL/r2x-core/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-core/issues?q=is%3Aopen+is%3Aissue+label%3AIdea): Future work or ideas for R2X Core.

r2x_plexos-0.1.0/README.md

@@ -0,0 +1,55 @@
+# r2x-plexos
+
+> R2X plug-in for translating to and from PLEXOS XML databases.
+>
+> [![image](https://img.shields.io/pypi/v/r2x.svg)](https://pypi.python.org/pypi/r2x-plexos)
+> [![image](https://img.shields.io/pypi/l/r2x.svg)](https://pypi.python.org/pypi/r2x-plexos)
+> [![image](https://img.shields.io/pypi/pyversions/r2x.svg)](https://pypi.python.org/pypi/r2x-plexos)
+> [![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-plexos/branch/main/graph/badge.svg)](https://codecov.io/gh/NREL/r2x-plexos)
+> [![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-plexos/actions/workflows/docs.yaml/badge.svg?branch=main)](https://nrel.github.io/r2x-plexos/)
+> [![Docstring Coverage](https://nrel.github.io/r2x-plexos/_static/docstr_coverage_badge.svg)](https://nrel.github.io/r2x-plexos/)
+
+
+R2X PLEXOS plugin for parsing and exporting PLEXOS power system models.
+
+## Quick Start
+
+### Installation
+
+```bash
+uv add r2x-plexos
+```
+
+### Parsing PLEXOS XML
+
+```python
+from pathlib import Path
+from r2x_core import DataFile, DataStore
+from r2x_plexos import PLEXOSParser, PLEXOSConfig
+
+# Parse PLEXOS XML
+config = PLEXOSConfig(model_name="Base", reference_year=2024)
+store = DataStore(path=Path("data"))
+store.add_data(DataFile(name="xml_file", glob="*.xml"))
+
+parser = PLEXOSParser(config, store)
+system = parser.build_system()
+```
+
+## Documentation Sections
+
+- [Tutorials](https://nrel.github.io/r2x-plexos/tutorials/) - Step-by-step learning guides
+- [How-To Guides](https://nrel.github.io/r2x-plexos/how-tos/) - Task-focused recipes
+- [Explanations](https://nrel.github.io/r2x-plexos/explanations/) - Architecture and design
+- [References](https://nrel.github.io/r2x-plexos/explanations/references/) - API and configuration reference
+
+## Roadmap
+
+If you're curious about what we're working on, check out the roadmap:
+
+- [Active issues](https://github.com/NREL/r2x-core/issues?q=is%3Aopen+is%3Aissue+label%3A%22Working+on+it+%F0%9F%92%AA%22+sort%3Aupdated-asc): Issues that we are actively working on.
+- [Prioritized backlog](https://github.com/NREL/r2x-core/issues?q=is%3Aopen+is%3Aissue+label%3ABacklog): Issues we'll be working on next.
+- [Nice-to-have](https://github.com/NREL/r2x-core/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-core/issues?q=is%3Aopen+is%3Aissue+label%3AIdea): Future work or ideas for R2X Core.

r2x_plexos-0.1.0/pyproject.toml

@@ -0,0 +1,136 @@
+[project]
+name = "r2x-plexos"
+version = "0.1.0"
+description = "Plexos Models, Parser and Exporter"
+readme = "README.md"
+requires-python = ">=3.11, <3.14"
+dependencies = [
+    "plexosdb>=1.1.3",
+    "r2x-core>=0.1.1,<1.0.0",
+]
+keywords=["PLEXOS"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: BSD License",
+    "Topic :: Software Development :: Build Tools",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "License :: OSI Approved :: BSD License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Topic :: File Formats :: JSON",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+    "Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator",
+    "Topic :: Software Development :: Build Tools",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+
+[dependency-groups]
+dev = [
+    "ipython>=9.2.0",
+    "mypy>=1.15.0",
+    "pre-commit>=4.2.0",
+    "pytest>=8.3.5",
+    "pytest-coverage>=0.0",
+    "pytest-mock>=3.15.1",
+    "ruff>=0.11.5",
+]
+docs = [
+    "autodoc-pydantic",
+    "docstr-coverage>=2.3.2",
+    "furo>=2025.9.25",
+    "ghp-import",
+    "myst-parser",
+    "sphinx>=8.0.0",
+    "sphinx-copybutton",
+    "sphinx-reports",
+    "sphinx-tabs",
+]
+
+[project.entry-points.r2x_plugin]
+plexos = "r2x_plexos.plugins:manifest"
+
+[project.urls]
+Homepage = "https://github.com/NREL/r2x-plexos"
+Documentation = "https://nrel.github.io/r2x-plexos/"
+Repository = "https://github.com/NREL/r2x-plexos"
+Issues = "https://github.com/NREL/r2x-plexos/issues"
+Changelog = "https://nrel.github.io/r2x-plexos/CHANGELOG.html"
+
+[build-system]
+requires = ["uv_build>=0.8.22,<0.9.0"]
+build-backend = "uv_build"
+
+[tool.pytest.ini_options]
+pythonpath = [
+  "src"
+]
+testpaths = ["tests"]
+markers = [
+  "slow: marks tests as slow (deselect with '-m \"not slow\"')",
+  "export: marks to test exporter functions",
+  "serialize: marks tests for serialization functionality"
+]
+
+[tool.mypy]
+strict = true
+exclude = ["tests/"]
+plugins = [
+  "pydantic.mypy"
+]
+
+
+[tool.ruff]
+line-length = 110
+extend-exclude = [
+    ".venv",
+    "venv",
+    "build",
+    "dist",
+    "*.egg-info",
+]
+
+[tool.ruff.lint]
+select = [
+    "D",      # pyddoc
+    "E",      # pycodestyle errors
+    "W",      # pycodestyle warnings
+    "F",      # pyflakes
+    "I",      # isort
+    "N",      # pep8-naming
+    "UP",     # pyupgrade
+    "B",      # flake8-bugbear
+    "C4",     # flake8-comprehensions
+    "SIM",    # flake8-simplify
+    "PIE",    # flake8-pie
+    "PERF",   # perflint (performance)
+    "RUF",    # ruff-specific rules
+]
+ignore = [
+    "E501",   # Line too long (handled by formatter)
+    "B027",   # Empty method in abstract class without @abstractmethod (intentional for hooks)
+]
+
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.lint.per-file-ignores]
+# Ignore `D` rules everywhere except for the `src/` directory.
+"!src/**.py" = ["D", "S101"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["r2x_core"]
+section-order = ["future", "standard-library", "third-party", "first-party", "local-folder"]
+
+[tool.ruff.lint.mccabe]
+# Cyclomatic complexity threshold
+max-complexity = 10

r2x_plexos-0.1.0/src/r2x_plexos/__init__.py

@@ -0,0 +1,49 @@
+"""R2X PLEXOS Plugin.
+
+A plugin for parsing PLEXOS model data into the R2X framework using infrasys components.
+"""
+
+from importlib.metadata import version
+
+from loguru import logger
+
+from .config import PLEXOSConfig
+from .models import (
+    PLEXOSObject,
+    PLEXOSProperty,
+    PLEXOSPropertyValue,
+    PLEXOSRow,
+    get_horizon,
+    get_scenario_priority,
+    horizon,
+    scenario_and_horizon,
+    scenario_priority,
+    set_horizon,
+    set_scenario_priority,
+)
+from .parser import PLEXOSParser
+
+__version__ = version("r2x_plexos")
+
+
+# Disable default loguru handler for library usage
+# Applications using this library should configure their own handlers
+logger.disable("r2x_plexos")
+
+
+__all__ = [
+    "PLEXOSConfig",
+    "PLEXOSObject",
+    "PLEXOSParser",
+    "PLEXOSProperty",
+    "PLEXOSPropertyValue",
+    "PLEXOSRow",
+    "__version__",
+    "get_horizon",
+    "get_scenario_priority",
+    "horizon",
+    "scenario_and_horizon",
+    "scenario_priority",
+    "set_horizon",
+    "set_scenario_priority",
+]

r2x_plexos-0.1.0/src/r2x_plexos/config/defaults.json

@@ -0,0 +1,18 @@
+{
+  "export-configuration": {
+    "time_series_naming_pattern": "${type(component).__name__}_$(ts_metadata).csv"
+  },
+  "horizon-properties": {},
+  "horizon_year": null,
+  "model-properties": {},
+  "models": [],
+  "properties-defaults": {
+    "Decomposition Method": 1,
+    "Dump Energy Price": -100,
+    "VoLL": 1000000.0,
+    "Wheeling Charge": 0.001,
+    "Wheeling Charge Back": 0.001
+  },
+  "resolution": null,
+  "template": null
+}

r2x_plexos-0.1.0/src/r2x_plexos/config/file_mapping.json

@@ -0,0 +1,7 @@
+[
+  {
+    "description": "PLEXOS XML file",
+    "glob": "*.xml",
+    "name": "xml_file"
+  }
+]