From c1ec91f5bac34d1d3f6b9a5cccaced437c0abad2 Mon Sep 17 00:00:00 2001 From: Fabian Neumann Date: Fri, 24 Jan 2020 17:02:09 +0100 Subject: [PATCH] doc: note on open-source solver setup [skip travis] --- doc/installation.rst | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/doc/installation.rst b/doc/installation.rst index 66609e04..4b54637e 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -60,7 +60,8 @@ and the non-free, commercial software (for which free academic licenses are avai - `Gurobi `_ - `CPLEX `_ -and any other solver that works with the underlying modelling framework `Pyomo `_. For installation instructions of these solvers for your operating system, follow the links above. +and any other solver that works with the underlying modelling framework `Pyomo `_. +For installation instructions of these solvers for your operating system, follow the links above. .. seealso:: `Getting a solver in the PyPSA documentation `_ @@ -69,6 +70,22 @@ and any other solver that works with the underlying modelling framework `Pyomo < Commercial solvers such as Gurobi and CPLEX currently significantly outperform open-source solvers for large-scale problems. It might be the case that you can only retrieve solutions by using a commercial solver. +.. note:: + The rules :mod:`cluster_network` and :mod:`simplify_network` solve a quadratic optimisation problem for clustering. + The open-source solvers Cbc and GlPK cannot handle this. A fallback to Ipopt is implemented in this case, but requires + also Ipopt to be installed. For an open-source solver setup install in your `conda` environment on OSX/Linux + + .. code:: bash + + conda install -c conda-forge ipopt coincbc + + and on Windows + + .. code:: bash + + conda install -c conda-forge ipopt glpk + + .. _defaultconfig: Set Up the Default Configuration