3. Command-Line Utility

This section provides details about how to use the gridopt command-line utility.

3.1. Syntax

The command-line utility gridopt can be used to load a network data file and solve the corresponding PF or OPF problem using an available method. One can also configure the parameters of the underlying optimization solver as well as the properties of the optimization problem constructed. The syntax and a description of each of the options is presented below.

Power grid optimization package.

usage: gridopt [-h] [--parameters [PARAMS [PARAMS ...]]] [--profile]
               [--flatstart] [--quiet] [--write OUTFILE]
               case method

3.1.1. Positional Arguments

case	filename of power flow case to solve
method	Possible choices: ACOPF, ACPF, DCOPF, DCPF PF or OPF method

3.1.2. Named Arguments

--parameters	parameter name-value pairs Default: []
--profile	flag for profiling execution Default: False
--flatstart	flag for flat starting point Default: False
--quiet	flag for supressing output Default: False
--write	name of output file Default: “”

3.2. Example

The following example shows how to use the command-line utility to solve an AC power flow problem using the Newton-Raphson algorithm with a feasibility tolerance of 1e-5 per unit system MVA:

gridopt ieee14.m ACPF --parameters feastol=1e-5 solver=nr

In this example, it is assumed that the command is executed from a directory where the sample case ieee14 is located.