| Name | r2x-core JSON |
| Version |
0.0.11
JSON |
| download |
| home_page | None |
| Summary | Extensible framework for building power system model translators with plugin architecture |
| upload_time | 2025-10-22 03:12:17 |
| maintainer | pesap, Kinshuk Panda, mcllerena, jarry7, kodiobika |
| docs_url | None |
| author | pesap, kodiobika, Vivienne Liu, Micah Webb, Kinshuk Panda, mcllerena, jarry7 |
| requires_python | >=3.11 |
| 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. |
| keywords |
power-systems
energy-modeling
model-translation
reeds
plexos
switch
sienna
plugin-architecture
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
### r2x-core
> Extensible framework for power system model translation
>
> [](https://pypi.python.org/pypi/r2x-core)
> [](https://pypi.python.org/pypi/r2x-core)
> [](https://pypi.python.org/pypi/r2x-core)
> [](https://github.com/NREL/r2x/actions/workflows/ci.yaml)
> [](https://codecov.io/gh/NREL/r2x-core)
> [](https://github.com/astral-sh/ruff)
> [](https://nrel.github.io/r2x-core/)
> [](https://nrel.github.io/r2x-core/)
R2X Core is a model-agnostic framework for building power system model translators.
It provides the core infrastructure, data models, plugin architecture, and APIs that enable translation between different power system modeling platforms like ReEDS, PLEXOS, SWITCH, Sienna, and more.
## Features
- Plugin-based architecture with automatic discovery and registration
- Support for multiple file formats: CSV, HDF5, Parquet, JSON, and XML
- Standardized power system component models via [infrasys](https://github.com/NREL/infrasys)
- Abstract base classes (`BaseParser`, `BaseExporter`) for implementing model translators
- Type-safe configuration management with Pydantic models
- Built-in data transformations, filters, and validations
- Flexible data store with automatic format detection
- System modifiers for applying transformations to power system models
## Quick Start
```console
pip install r2x-core
```
```python
from r2x_core import PluginManager, BaseParser
# Register your model plugin
PluginManager.register_model_plugin(
name="my_model",
config=MyModelConfig,
parser=MyModelParser,
exporter=MyModelExporter,
)
# Use it
manager = PluginManager()
parser = manager.load_parser("my_model")
system = parser(config, data_store).build_system()
```
👉 [See the full tutorial](https://nrel.github.io/r2x-core/tutorials/getting-started/) for a complete example.
## Documentation
- [Getting Started Tutorial](https://nrel.github.io/r2x-core/tutorials/getting-started/) - Step-by-step guide to building your first translator
- [Plugin System Guide](https://nrel.github.io/r2x-core/explanations/plugin-system/) - Understanding the plugin architecture
- [How-To Guides](https://nrel.github.io/r2x-core/how-tos/) - Task-oriented guides for common workflows
- [API Reference](https://nrel.github.io/r2x-core/references/) - Complete API documentation
## 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "r2x-core",
"maintainer": "pesap, Kinshuk Panda, mcllerena, jarry7, kodiobika",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "pesap <pesap@users.noreply.github.com>, Kinshuk Panda <7632244+k1nshuk@users.noreply.github.com>, mcllerena <mcllerena@users.noreply.github.com>, jarry7 <27745389+jarry7@users.noreply.github.com>, kodiobika <kodiobika@users.noreply.github.com>",
"keywords": "power-systems, energy-modeling, model-translation, reeds, plexos, switch, sienna, plugin-architecture",
"author": "pesap, kodiobika, Vivienne Liu, Micah Webb, Kinshuk Panda, mcllerena, jarry7",
"author_email": "pesap <pesap@users.noreply.github.com>, kodiobika <kodiobika@users.noreply.github.com>, Vivienne Liu <vivienne.liu@nrel.gov>, Micah Webb <micahpw@user.noreply.github.com>, Kinshuk Panda <7632244+k1nshuk@users.noreply.github.com>, mcllerena <mcllerena@users.noreply.github.com>, jarry7 <27745389+jarry7@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/47/f2/38564dc358ea49119cc4d5db3f866f9f6d94ca2c8e283f9902fafff433ef/r2x_core-0.0.11.tar.gz",
"platform": null,
"description": "### r2x-core\n> Extensible framework for power system model translation\n>\n> [](https://pypi.python.org/pypi/r2x-core)\n> [](https://pypi.python.org/pypi/r2x-core)\n> [](https://pypi.python.org/pypi/r2x-core)\n> [](https://github.com/NREL/r2x/actions/workflows/ci.yaml)\n> [](https://codecov.io/gh/NREL/r2x-core)\n> [](https://github.com/astral-sh/ruff)\n> [](https://nrel.github.io/r2x-core/)\n> [](https://nrel.github.io/r2x-core/)\n\n\n\nR2X Core is a model-agnostic framework for building power system model translators.\nIt provides the core infrastructure, data models, plugin architecture, and APIs that enable translation between different power system modeling platforms like ReEDS, PLEXOS, SWITCH, Sienna, and more.\n\n## Features\n\n- Plugin-based architecture with automatic discovery and registration\n- Support for multiple file formats: CSV, HDF5, Parquet, JSON, and XML\n- Standardized power system component models via [infrasys](https://github.com/NREL/infrasys)\n- Abstract base classes (`BaseParser`, `BaseExporter`) for implementing model translators\n- Type-safe configuration management with Pydantic models\n- Built-in data transformations, filters, and validations\n- Flexible data store with automatic format detection\n- System modifiers for applying transformations to power system models\n\n## Quick Start\n\n```console\npip install r2x-core\n```\n\n```python\nfrom r2x_core import PluginManager, BaseParser\n\n# Register your model plugin\nPluginManager.register_model_plugin(\n name=\"my_model\",\n config=MyModelConfig,\n parser=MyModelParser,\n exporter=MyModelExporter,\n)\n\n# Use it\nmanager = PluginManager()\nparser = manager.load_parser(\"my_model\")\nsystem = parser(config, data_store).build_system()\n```\n\n\ud83d\udc49 [See the full tutorial](https://nrel.github.io/r2x-core/tutorials/getting-started/) for a complete example.\n\n## Documentation\n\n- [Getting Started Tutorial](https://nrel.github.io/r2x-core/tutorials/getting-started/) - Step-by-step guide to building your first translator\n- [Plugin System Guide](https://nrel.github.io/r2x-core/explanations/plugin-system/) - Understanding the plugin architecture\n- [How-To Guides](https://nrel.github.io/r2x-core/how-tos/) - Task-oriented guides for common workflows\n- [API Reference](https://nrel.github.io/r2x-core/references/) - Complete API documentation\n\n## Roadmap\n\nIf you're curious about what we're working on, check out the roadmap:\n\n- [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.\n- [Prioritized backlog](https://github.com/NREL/r2x-core/issues?q=is%3Aopen+is%3Aissue+label%3ABacklog): Issues we'll be working on next.\n- [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).\n- [Ideas](https://github.com/NREL/r2x-core/issues?q=is%3Aopen+is%3Aissue+label%3AIdea): Future work or ideas for R2X Core.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License\n \n Copyright (c) 2025, Alliance for Sustainable Energy LLC, All rights reserved.\n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n \n 1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n \n 2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n \n 3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Extensible framework for building power system model translators with plugin architecture",
"version": "0.0.11",
"project_urls": {
"Changelog": "https://nrel.github.io/r2x-core/CHANGELOG.html",
"Documentation": "https://nrel.github.io/r2x-core/",
"Homepage": "https://github.com/NREL/r2x-core",
"Issues": "https://github.com/NREL/r2x-core/issues",
"Repository": "https://github.com/NREL/r2x-core"
},
"split_keywords": [
"power-systems",
" energy-modeling",
" model-translation",
" reeds",
" plexos",
" switch",
" sienna",
" plugin-architecture"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9fc5133a0e8ad9e3c2836dbf851b8e43a14b26529152b713720e56724e92547b",
"md5": "189be9bdfdb65f9ea16ef7600b1c45ff",
"sha256": "816187066c229ff97fa45fbc9480f176046584f373b4c5383cb008686a8c7e75"
},
"downloads": -1,
"filename": "r2x_core-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "189be9bdfdb65f9ea16ef7600b1c45ff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 69294,
"upload_time": "2025-10-22T03:12:15",
"upload_time_iso_8601": "2025-10-22T03:12:15.734483Z",
"url": "https://files.pythonhosted.org/packages/9f/c5/133a0e8ad9e3c2836dbf851b8e43a14b26529152b713720e56724e92547b/r2x_core-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "47f238564dc358ea49119cc4d5db3f866f9f6d94ca2c8e283f9902fafff433ef",
"md5": "8dd3db6f784c11de24ba7b29eb9111af",
"sha256": "c8de33433fe453321056ad26a62b1a07772eb48bc8e9f699e1f16f662904edc5"
},
"downloads": -1,
"filename": "r2x_core-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "8dd3db6f784c11de24ba7b29eb9111af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 58889,
"upload_time": "2025-10-22T03:12:17",
"upload_time_iso_8601": "2025-10-22T03:12:17.455271Z",
"url": "https://files.pythonhosted.org/packages/47/f2/38564dc358ea49119cc4d5db3f866f9f6d94ca2c8e283f9902fafff433ef/r2x_core-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-22 03:12:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NREL",
"github_project": "r2x-core",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "r2x-core"
}
