GridDyn documentation

GridDyn is an open-source power-system simulation framework for steady-state, time-domain, and coupled studies. The Python package provides an installable interface for common simulation workflows; the C++ project provides the core simulation engine and additional integrations.

For users of the Python package, start with installation, then follow the quick start or the detailed Python interface guide. Source-build instructions and the C++ documentation workflow are in Building GridDyn. For GridDyn-specific network files, see GridDyn XML inputs.

User guides

• Overview
• Installation
  • Python package
  • Build from source
• Quick start
  • Try the installed Python package
  • Load your own network
• GridDyn XML inputs
  • Network structure
  • Dynamic models and output
  • Imports and reader directives
• Python interface
  • Load and run a network
  • Runnable examples
  • Write output files
  • DC optimal power flow
  • Capability notes
• Capabilities and limits
• Building GridDyn
  • Configure and build on Windows
  • Configure and build on Linux
  • Install and find the command-line executable
  • Run the C++ test suite
  • Build the Python package from source
  • Generate the C++ API reference

Maintainer notes

• Documentation release plan

The Doxygen API reference is generated from the C++ source separately. Its build command and current documentation work plan are described in Building GridDyn and the documentation release plan.