Installation¶

Requirements¶

Python 3.10 or later
uv (recommended) or pip

Basic Install¶

pip install openg2g

Warning

OpenG2G is currently under active development. For the latest features and bug fixes, we recommend installing from the master branch on GitHub. See Quickstart for instructions.

With Grid Simulation¶

To use the OpenDSS-based grid simulator:

pip install "openg2g[opendss]"

This adds OpenDSSDirect.py, which provides the Python bindings for OpenDSS.

Why is this not the default?

OpenDSSDirect.py is not included by default due to license incompatibilities. We're communicating with the team to resolve this.

Next Steps¶

To run simulations, you'll need to build the data artifacts first. See Quickstart for data requirements and Data Pipeline for the full build process.