Skip to content

openclimatefix/nged-substation-forecast

Repository files navigation

NGED substation forecast

ease of contribution: hard

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.

Development

This repo is a uv workspace: A single repo which contains multiple Python packages.

Setup

  1. Ensure uv is installed following their official documentation.
  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 community.

OCF Logo

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

  •  

Packages

 
 
 

Contributors