Installation
GridOverture requires Python 3.11 or higher.
Quick Install
Install the core library with pip:
pip install gridoverture
Solver Extras
GridOverture uses optional extras to install solver backends. Install only what you need:
- ANDES
- Veragrid
- PyPSA
- pandapower
- All solvers
pip install gridoverture[andes]
pip install gridoverture[veragrid]
pip install gridoverture[pypsa]
pip install gridoverture[pandapower]
pip install gridoverture[all]
Start with gridoverture[veragrid] if you're unsure — Veragrid is lightweight and works well for most use cases.
From Source
For development or to get the latest unreleased changes:
git clone https://github.com/Grid-Overture/gridoverture-platform.git
cd gridoverture-platform
uv sync
We use uv for dependency management. Install it with pip install uv or curl -LsSf https://astral.sh/uv/install.sh | sh.
Verify Installation
Confirm everything is working:
import gridoverture as go
print(go.__version__)
# v0.4.0
# List available solvers
print(go.available_solvers())
# ['veragrid', 'andes', 'pypsa', 'pandapower', 'dc', 'pypsa-dc', 'pandapower-dc']
# List available test networks
print(go.available_networks())
# ['ieee14', 'ieee24', 'ieee39', 'ieee57', 'ieee118', 'ieee300', 'uk_29bus', 'wecc240']
Troubleshooting
ImportError: No module named 'gridoverture'
Make sure you installed the package in the correct Python environment. Check with which python and verify it matches the environment where you ran pip install.
Solver not found
If go.available_solvers() doesn't list the solver you expect, install the corresponding extra. For example: pip install gridoverture[andes].
Python version error
GridOverture requires Python 3.11+. Check your version with python --version and upgrade if needed.