From ac1e375bc55fdbe6b8c4baeb7be10e43957a999d Mon Sep 17 00:00:00 2001 From: Simon Bowly Date: Mon, 31 Jul 2023 08:37:01 +1000 Subject: [PATCH] Update OPF docs --- docs/source/mods/opf/opf.rst | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/docs/source/mods/opf/opf.rst b/docs/source/mods/opf/opf.rst index 18ed45bb..24390e1a 100644 --- a/docs/source/mods/opf/opf.rst +++ b/docs/source/mods/opf/opf.rst @@ -101,20 +101,13 @@ argument specifies otherwise. ... ACOPF and `Branch-Switching`_ models are most often very hard to solve to -optimality. For this reason, it is best to pass specific solver settings such -as, e.g., a `TimeLimit -`_. This can -be done by using the ``solver_params`` argument. For a full list of all Gurobi -parameters please refer to `our documentation -`_. +optimality. For this reason, it is recommended to specify a solver time limit +using the ``time_limit`` parameter. If the problem has not been solved to +optimality within the time limit, the best known solution will be returned. .. testcode:: opf - result = opf.solve_opf( - case, - opftype="AC", - solver_params={"TimeLimit": 60} - ) + result = opf.solve_opf(case, opftype="AC", time_limit=60) .. testoutput:: opf :hide: