Getting started#

Install#

Sign in or create an account at the account portal. Review and accept the GPF End User License Agreement to access the downloads. One acceptance covers every GPF edition and distribution, including desktop applications and Python packages.

The Free downloads section provides desktop installers, Python wheels, and a pip install command. The free edition is available at no cost and does not require a license key or activation.

For the desktop application, download the installer for your operating system and run it. The application includes Python.

For a Python environment, copy the free install command from the portal or download a wheel and install that file with python -m pip install <wheel-file>. The project package index supplies gpf. Dependencies come from PyPI.

For a commercial edition, follow the install and activation instructions in the account portal. The portal also provides instructions for containers and automated environments.

Requirements

  • Python 3.12 or newer

  • Linux x86-64, or Windows x86-64

Solve a case#

from gpf import load_case, solve_power_flow, render

case = load_case("ieee39.raw")     # the suffix picks the parser
sol = solve_power_flow(case)
print(render(sol))

CLI#

gpf solve ieee39.raw

AI assistant#

An MCP server ships with every install, so an assistant can load a case, solve it, and run studies on its own. Register it with Claude Code by running:

claude mcp add -s user gpf -- gpf mcp

Codex, Cursor, and other clients are configured in Use gpf from an AI agent.

Next steps#

  • Concepts defines the vocabulary the rest of the guide uses.

  • Transmission power flow explains the positive-sequence solve contract, case checks, and results.

  • Tutorials cover the data model, reading results, and scenario studies in depth.

  • Recipes are copy-paste answers to common tasks.

  • Use gpf from an AI agent connects the same workflows to an assistant.

  • The gpf Reference lists every function, method, and command-line option.