Skip to main content

Facade API

info

Full API documentation is coming soon. Below is an outline of the public API surface.

Planned Content​

  • go.load(name) — load a test network by name, returns IRNetwork
  • go.run_load_flow(net, solver) — run AC/DC power flow, returns LoadFlowResult
  • go.run_opf(net, solver) — run optimal power flow, returns OPFResult
  • go.compare(net, solvers) — compare results across solvers, returns ComparisonResult
  • go.available_solvers() — list installed solver backends
  • go.available_networks() — list built-in test networks
  • go.solver_available(name) — check if a solver is installed
  • go.__version__ — current library version