grid-reducer

A repository for performing network reduction in distribution system power flow model.

https://github.com/grid-atlas/grid-reducer

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (16.0%) to scientific vocabulary

Keywords

mkdocs-material opendss python

Last synced: 6 months ago · JSON representation ·

Repository

A repository for performing network reduction in distribution system power flow model.

Basic Info

Host: GitHub
Owner: Grid-Atlas
License: bsd-3-clause
Language: Python
Default Branch: main
Homepage: https://grid-atlas.github.io/grid-reducer/
Size: 5.1 MB

Statistics

Stars: 4
Watchers: 0
Forks: 0
Open Issues: 3
Releases: 3

Topics

mkdocs-material opendss python

Created 9 months ago · Last pushed 6 months ago

Metadata Files

Readme Changelog License Citation

⚡ Getting Started with `grid-reducer`

Python License Coverage

View Full Documentation..

Welcome! Follow the steps below to get grid-reducer up and running locally.
We recommend using a Python virtual environment for a clean install 🔒🐍.

🧪 Step 1: Set Up a Python Environment

To avoid dependency conflicts, create and activate a virtual environment.

You can use any tool of your choice — here are a few popular options:

🟢 Option A: Using venv (Standard Library)

```bash python3 -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate ```

🔵 Option B: Using conda

```bash conda create -n grid-reducer-env python=3.11 conda activate grid-reducer-env ```

🚀 Step 2: Install the Project Locally

Install the project in editable mode so changes to the code reflect immediately:

bash pip install grid_reducer

✅ This will also install all required dependencies.

🛠 Example CLI Usage

Once installed, you can use command line interface. Run grid --help to see all the available command options.

Here is a minimal example to reduce OpenDSS model.

bash grid reduce -f Master.dss

Example Python Usage

You can also reduce the feeder model through python scripts.

Here is a minimal example to reduce OpenDSS feeder model using Python Script.

```python from pathlib import Path

from grid_reducer.reducer import OpenDSSModelReducer

filepath = "master.dss" reducer = OpenDSSModelReducer(masterdssfile=filepath) reducedckt = reducer.reduce(transformcoordinate=True)

outfolder = Path("outputs") outfolder.mkdir(parents=True, existok=True) originalcircuitfile = outfolder / "originalckt.dss" reducedcircuitfile = outfolder / "reducedckt.dss" reducer.exportoriginalckt(originalcircuitfile) reducer.export(reducedckt, reducedcircuitfile) ```

📌 Notes

This is the recommended way to use the project during development.
In the future, the project may support installation via:

bash pip install grid-reducer

Stay tuned for updates! 📬

Need help? Feel free to open an issue or reach out to the maintainers. 💬

Attribution and Disclaimer

This software was created under a project sponsored by the U.S. Department of Energy’s Office of Electricity, an agency of the United States Government. Neither the United States Government nor the United States Department of Energy, nor Battelle, nor any of their employees, nor any jurisdiction or organization that has cooperated in the development of these materials, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness or any information, apparatus, product, software, or process disclosed, or represents that its use would not infringe privately owned rights.

Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise does not necessarily constitute or imply its endorsement, recommendation, or favoring by the United States Government or any agency thereof, or Battelle Memorial Institute. The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof.

PACIFIC NORTHWEST NATIONAL LABORATORY

operated by BATTELLE

for the UNITED STATES DEPARTMENT OF ENERGY

under Contract DE-AC05-76RL01830

Owner

Name: Grid-Atlas
Login: Grid-Atlas
Kind: organization

Repositories: 1
Profile: https://github.com/Grid-Atlas

Citation (CITATION.cff)

cff-version: 1.2.0
title: Grid Reducer
message: 'If you use this software, please cite it as below.'
type: software
authors:
  - family-names: Duwadi
    given-names: Kapil
  - family-names: Bhattacharjee
    given-names: Kaustav
  - family-names: Anderson
    given-names: Alexander
  - family-names: Sadnam
    given-names: Rabayet
repository-code: 'https://github.com/Grid-Atlas/grid-reducer'
url: 'https://grid-atlas.github.io/grid-reducer'
abstract: >-
  A light weight Python Package for reducing OpenDSS Models.

  Uses altdss to read opendss model data in Pydantic format, applies
  algorithms to strip down the secondary, aggregates assets to nearest
  primary node and merge similar primary edges.
keywords:
  - python
  - altdss
  - pydantic
  - opendss
license: BSD-3-Clause
version: v1.0.0
funding:
  - name: U.S. Department of Energy's Office of Electricity
    url: 'https://www.energy.gov/oe/office-electricity'
    contract-number: 'DE-AC05-76RL01830'
date-released: 2025-07-01

GitHub Events

Total

Create event: 8
Issues event: 5
Watch event: 3
Delete event: 9
Issue comment event: 7
Push event: 45
Public event: 1
Pull request event: 23
Pull request review comment event: 12
Pull request review event: 5

Last Year

Create event: 8
Issues event: 5
Watch event: 3
Delete event: 9
Issue comment event: 7
Push event: 45
Public event: 1
Pull request event: 23
Pull request review comment event: 12
Pull request review event: 5

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 0
Total pull requests: 1
Average time to close issues: N/A
Average time to close pull requests: less than a minute
Total issue authors: 0
Total pull request authors: 1
Average comments per issue: 0
Average comments per pull request: 0.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 1
Average time to close issues: N/A
Average time to close pull requests: less than a minute
Issue authors: 0
Pull request authors: 1
Average comments per issue: 0
Average comments per pull request: 0.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

KapilDuwadi (3)
kaustavbhattacharjee (2)

Pull Request Authors

KapilDuwadi (10)
kaustavbhattacharjee (3)

Top Labels

Issue Labels

feature request (3) refactor (2) tech debt (2)

Pull Request Labels

feature request (1) enhancement (1)

Packages

Total packages: 1
Total downloads:
- pypi 102 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 3
Total maintainers: 1

pypi.org: grid-reducer

A repository for performing network reduction on distribution network model.

Documentation: https://github.com/grid-atlas/grid-reducer
License: bsd-3-clause
Latest release: 1.1.0
published 6 months ago

Versions: 3
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 102 Last month

Rankings

Dependent packages count: 8.9%

Average: 29.5%

Dependent repos count: 50.0%

Maintainers (1)

KapilDuwadi