Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified .DS_Store
Binary file not shown.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ body:
options:
- label: I have searched existing issues for a duplicate issue and I'm sure this is new.
required: True
- label: I have read and followed [the docs](https://nrel-distribution-suites.github.io/shift) and still think this is a bug.
- label: I have read and followed [the docs](https://nlr-distribution-suite.github.io/shift) and still think this is a bug.
required: True
- label: >
I am certain that this is an issue with shift
(not my code or another library such as [grid-data-models](https://github.com/NREL-Distribution-Suites/grid-data-models))
(not my code or another library such as [grid-data-models](https://github.com/NLR-Distribution-Suite/grid-data-models))
required: True

- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: 🤔 Ask a Question
url: "https://github.com/NREL-Distribution-Suites/shift/discussions/new?category=question"
url: "https://github.com/NLR-Distribution-Suite/shift/discussions/new?category=question"
about: Ask a question about how to use shift using github discussions
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ body:
options:
- label: I have searched existing issues for a duplicate feature request and I'm sure this is new.
required: True
- label: I have read and followed [the docs](https://nrel-distribution-suites.github.io/shift) and still think this is missing.
- label: I have read and followed [the docs](https://nlr-distribution-suite.github.io/shift) and still think this is missing.
required: True

- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pull_request_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ jobs:
- uses: davidslusser/actions_python_ruff@v1.0.1
with:
src: "check src"
pip_install_command: "pip install -e .[dev,mcp]"
pip_install_command: "pip install -e .[dev]"
python_version: "3.11"
4 changes: 2 additions & 2 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ jobs:
pytest --cov=shift --cov-report=xml --cov-report=term

- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.11'
uses: codecov/codecov-action@v5
if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
with:
file: ./coverage.xml
flags: unittests
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,8 +278,8 @@ Include:

## Questions and Support

- **Issues**: Use [GitHub Issues](https://github.com/NREL-Distribution-Suites/shift/issues) for bugs and feature requests
- **Discussions**: Use [GitHub Discussions](https://github.com/NREL-Distribution-Suites/shift/discussions) for questions
- **Issues**: Use [GitHub Issues](https://github.com/NLR-Distribution-Suite/shift/issues) for bugs and feature requests
- **Discussions**: Use [GitHub Discussions](https://github.com/NLR-Distribution-Suite/shift/discussions) for questions
- **Email**: Contact maintainers for sensitive issues

## License
Expand Down
2 changes: 1 addition & 1 deletion QUICKSTART.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Get a development environment running in under five minutes.
### 1. Clone and Install

```bash
git clone https://github.com/NREL-Distribution-Suites/shift.git
git clone https://github.com/NLR-Distribution-Suite/shift.git
cd shift

python -m venv venv
Expand Down
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
![Tests](https://github.com/NLR-Distribution-Suite/shift/actions/workflows/tests.yml/badge.svg) • ![PR Tests](https://github.com/NLR-Distribution-Suite/shift/actions/workflows/pull_request_tests.yml/badge.svg) • ![Docs](https://github.com/NLR-Distribution-Suite/shift/actions/workflows/gh-pages.yml/badge.svg) • ![Publish](https://github.com/NLR-Distribution-Suite/shift/actions/workflows/publish.yml/badge.svg) • ![PyPI Downloads](https://img.shields.io/pypi/dm/nrel-shift) • ![License](https://img.shields.io/github/license/NLR-Distribution-Suite/shift) • ![Issues](https://img.shields.io/github/issues/NLR-Distribution-Suite/shift) • ![CodeFactor](https://www.codefactor.io/repository/github/NLR-Distribution-Suite/shift/badge) • ![Codecov](https://img.shields.io/codecov/c/github/NLR-Distribution-Suite/shift) • ![MCP Server](https://img.shields.io/badge/MCP_Server-enabled-brightgreen) • ![MCP Tools](https://img.shields.io/badge/MCP_Tools-33-blue)

# NREL-shift

A Python framework for building synthetic power distribution feeder models from open-source geospatial data. NREL-shift fetches building parcels and road networks from OpenStreetMap, constructs graph-based network topologies, and exports simulator-ready models through [Grid Data Models](https://github.com/NREL-Distribution-Suites/grid-data-models) and [Ditto](https://github.com/NREL-Distribution-Suites/ditto).
A Python framework for building synthetic power distribution feeder models from open-source geospatial data. NREL-shift fetches building parcels and road networks from OpenStreetMap, constructs graph-based network topologies, and exports simulator-ready models through [Grid Data Models](https://github.com/NLR-Distribution-Suite/grid-data-models) and [Ditto](https://github.com/NLR-Distribution-Suite/ditto).

## Features

Expand All @@ -23,7 +25,7 @@ pip install nrel-shift
### From Source

```bash
git clone https://github.com/NREL-Distribution-Suites/shift.git
git clone https://github.com/NLR-Distribution-Suite/shift.git
cd shift
pip install -e .
```
Expand Down Expand Up @@ -192,7 +194,7 @@ pytest -m "not slow" # Skip slow tests
- Python >= 3.10
- [OSMnx](https://osmnx.readthedocs.io/) — OpenStreetMap data access
- [NetworkX](https://networkx.org/) — Graph operations
- [Grid Data Models](https://github.com/NREL-Distribution-Suites/grid-data-models) — Power system component models
- [Grid Data Models](https://github.com/NLR-Distribution-Suite/grid-data-models) — Power system component models
- See [pyproject.toml](./pyproject.toml) for the complete dependency list

## License
Expand All @@ -201,9 +203,9 @@ BSD-3-Clause — see [LICENSE.txt](./LICENSE.txt).

## Authors

- Kapil Duwadi (Kapil.Duwadi@nrel.gov)
- Aadil Latif (Aadil.Latif@nrel.gov)
- Erik Pohl (Erik.Pohl@nrel.gov)
- Kapil Duwadi (Kapil.Duwadi@nlr.gov)
- Aadil Latif (Aadil.Latif@nlr.gov)
- Erik Pohl (Erik.Pohl@nlr.gov)

## Citation

Expand All @@ -212,11 +214,11 @@ BSD-3-Clause — see [LICENSE.txt](./LICENSE.txt).
title = {NREL-shift: Framework for Developing Synthetic Distribution Feeder Models},
author = {Duwadi, Kapil and Latif, Aadil and Pohl, Erik},
year = {2026},
url = {https://github.com/NREL-Distribution-Suites/shift}
url = {https://github.com/NLR-Distribution-Suite/shift}
}
```

## Support

- [Open an issue](https://github.com/NREL-Distribution-Suites/shift/issues) for bugs and feature requests
- [Discussions](https://github.com/NREL-Distribution-Suites/shift/discussions) for questions
- [Open an issue](https://github.com/NLR-Distribution-Suite/shift/issues) for bugs and feature requests
- [Discussions](https://github.com/NLR-Distribution-Suite/shift/discussions) for questions
Binary file added docs/.DS_Store
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# NREL-shift

A Python framework for building synthetic power distribution feeder models from open-source geospatial data. NREL-shift fetches building parcels and road networks from OpenStreetMap, constructs graph-based network topologies, and exports simulator-ready models via [Grid Data Models](https://github.com/NREL-Distribution-Suites/grid-data-models).
A Python framework for building synthetic power distribution feeder models from open-source geospatial data. NREL-shift fetches building parcels and road networks from OpenStreetMap, constructs graph-based network topologies, and exports simulator-ready models via [Grid Data Models](https://github.com/NLR-Distribution-Suite/grid-data-models).

## Installation

Expand Down
2 changes: 1 addition & 1 deletion docs/usage/building_system.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ system.to_json(output_folder / "fort_worth_feeder.json")

## Export to a Simulator

The `DistributionSystem` object is compatible with [Ditto](https://github.com/NREL-Distribution-Suites/ditto) writers for exporting to OpenDSS, CYME, Synergi, and other simulators:
The `DistributionSystem` object is compatible with [Ditto](https://github.com/NLR-Distribution-Suite/ditto) writers for exporting to OpenDSS, CYME, Synergi, and other simulators:

```python
# Example (requires the Ditto package)
Expand Down
14 changes: 7 additions & 7 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ requires-python = ">=3.10"
license = "BSD-3-clause"
keywords = []
authors = [
{ name = "Kapil Duwadi", email = "Kapil.Duwadi@nrel.gov" },
{ name = "Aadil Latif", email = "Aadil.Latif@nrel.gov" },
{ name = "Erik Pohl", email = "Erik.Pohl@nrel.gov" },
{ name = "Kapil Duwadi", email = "Kapil.Duwadi@nlr.gov" },
{ name = "Aadil Latif", email = "Aadil.Latif@nlr.gov" },
{ name = "Erik Pohl", email = "Erik.Pohl@nlr.gov" },
]
classifiers = [
"Programming Language :: Python :: 3.11",
Expand All @@ -29,7 +29,7 @@ dependencies = [
"scikit-learn",
"plotly",
"geopy",
"grid-data-models==2.2.1",
"grid-data-models==2.3.0",
"importlib-metadata",
"loguru",
]
Expand All @@ -43,9 +43,9 @@ mcp = ["mcp[cli]>=1.2.0", "pyyaml"]
shift-mcp-server = "shift.mcp_server.__main__:main"

[project.urls]
Documentation = "https://github.com/NREL-Distribution-Suites/shift#readme"
Issues = "https://github.com/NREL-Distribution-Suites/shift/issues"
Source = "https://github.com/NREL-Distribution-Suites/shift"
Documentation = "https://github.com/NLR-Distribution-Suite/shift#readme"
Issues = "https://github.com/NLR-Distribution-Suite/shift/issues"
Source = "https://github.com/NLR-Distribution-Suite/shift"

[tool.ruff]
# Exclude a variety of commonly ignored directories.
Expand Down
2 changes: 1 addition & 1 deletion src/shift/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import platform
import sys

VERSION = "0.6.2"
VERSION = "0.6.3"


def is_git_repo(dir: Path) -> bool:
Expand Down
Binary file added tests/.DS_Store
Binary file not shown.
4 changes: 2 additions & 2 deletions tests/test_complete_system_from_location.py
Original file line number Diff line number Diff line change
Expand Up @@ -336,8 +336,8 @@ def test_build_complete_distribution_model_from_location():
assert "load_2" in load_bus_names

# Verify connectivity
_ = system.get_component(DistributionBus, "substation")
_ = system.get_component(DistributionBus, "secondary_1")
# substation_bus = system.get_component(DistributionBus, "substation")
# secondary_bus = system.get_component(DistributionBus, "secondary_1")

# Transformer should connect substation to secondary
transformer_buses = [bus.name for bus in transformers[0].buses]
Expand Down
Loading