https://github.com/openclimatefix/nged-substation-forecast

Forecast net demand at NGED's primary, BSP, and GSP substations. And more!
https://github.com/openclimatefix/nged-substation-forecast

Last synced: about 1 month ago
JSON representation

Forecast net demand at NGED's primary, BSP, and GSP substations. And more!

• Host: GitHub
• URL: https://github.com/openclimatefix/nged-substation-forecast
• Owner: openclimatefix
• License: mit
• Created: 2025-12-11T12:14:43.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2026-04-27T21:41:56.000Z (about 1 month ago)
• Last Synced: 2026-04-27T22:24:16.713Z (about 1 month ago)
• Language: Python
• Homepage: https://openclimatefix.github.io/nged-substation-forecast
• Size: 36.6 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Roadmap: docs/roadmap.md

Awesome Lists containing this project

README

          
# NGED substation forecast

[![ease of contribution: hard](https://img.shields.io/badge/ease%20of%20contribution:%20hard-bb2629)](https://github.com/openclimatefix#how-easy-is-it-to-get-involved)

To external contributors: Please note that this repo holds the very-early-stage research code for a new project, and there will be a lot of code churn over the next few months. As such, this repo isn't suitable for external contributions at the moment, sorry.

---

## Documentation

For detailed information about the project, including architecture, design philosophy, and user guides, please visit our [documentation site](https://openclimatefix.github.io/nged-substation-forecast/).

## Development

This repo is a `uv` [workspace](https://docs.astral.sh/uv/concepts/projects/workspaces): A single repo which contains multiple Python packages.

### Setup

1. Ensure [`uv`](https://docs.astral.sh/uv/) is installed following their [official documentation](https://docs.astral.sh/uv/getting-started/installation/).

2. **Install dependencies**: `uv sync`

3. **Install pre-commit hooks**: `uv run pre-commit install`

### Linting & Formatting

- **Check linting**: `uv run ruff check .`

- **Fix linting**: `uv run ruff check . --fix`

- **Format code**: `uv run ruff format .`

- **Type checking**: `uv run ty check`

### Testing

- **Run only the fast tests**: `uv run pytest -m "not slow"`

- **Run only the slow tests**: `uv run pytest -m "slow"`

- **Run all tests**: `uv run pytest`

- **Run tests with coverage**: `uv run pytest --cov`

### Development

- **Run Dagster UI**: `uv run dagster dev`

- Open http://localhost:3000 in your browser to see the project.

- **Run Marimo notebooks**: `uv run marimo edit packages/notebooks/some_notebook.py`

---

*Part of the [Open Climate Fix](https://github.com/orgs/openclimatefix/people) community.*

[![OCF Logo](https://cdn.prod.website-files.com/62d92550f6774db58d441cca/6324a2038936ecda71599a8b_OCF_Logo_black_trans.png)](https://openclimatefix.org)