Skip to content

Commit

Permalink
Fix typo in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
simonbowly committed Jul 31, 2023
1 parent 021f2e4 commit 360375d
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/source/mods/opf/opf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ above, we can solve an OPF problem defined by the given network data. For this
task, we use the :func:`~gurobi_optimods.opf.solve_opf` function. We can define
the type of the OPF problem that we want to solve by defining the ``opftype``
argument when calling the function. Currently, the available options are ``AC``,
``AC_relax``, and ``DC``.
``ACrelax``, and ``DC``.

- The ``AC`` setting solves an ACOPF problem defined by the given network data.
The ACOPF problem is formulated as a nonconvex bilinear model as described in
Expand All @@ -196,7 +196,7 @@ argument when calling the function. Currently, the available options are ``AC``,
it is also the most difficult problem to solve and thus usually leads to the
longer runtimes.

- The ``AC_relax`` setting solves a Second Order Cone (SOC) relaxation of the
- The ``ACrelax`` setting solves a Second Order Cone (SOC) relaxation of the
nonconvex bilinear ACOPF problem formulation defined by the given network
data. The relaxation is constructed by dropping nonconvex bilinear terms but
simultaneously keeping the convex JABR inequalities, see :ref:`JABR Relaxation
Expand Down
2 changes: 1 addition & 1 deletion src/gurobi_optimods/opf/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ def solve_opf(
case : dict
Dictionary holding case data
opftype : str
Desired OPF model type. One of ``AC``, ``AC_Relax``, or ``DC``
Desired OPF model type. One of ``AC``, ``ACrelax``, or ``DC``
branch_switching : bool, optional
If set to True, enables branch switching.
min_active_branches : float, optional
Expand Down

0 comments on commit 360375d

Please sign in to comment.