Skip to content

Commit 7447ab4

Browse files
authored
Update readme with Cbc.Optimizer (#113)
1 parent eaef881 commit 7447ab4

File tree

1 file changed

+5
-10
lines changed

1 file changed

+5
-10
lines changed

README.md

+5-10
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,17 @@ If you do not want BinaryProvider to download the default binaries on install se
3434

3535
To switch back to the default binaries clear `JULIA_CBC_LIBRARY_PATH` and call `import Pkg; Pkg.build("Cbc")`.
3636

37-
### Using with **[MathProgBase]**
38-
39-
Cbc provides a solver object that can be passed to ``mixintprog`` in MathProgBase (and used to create instances of the solver-independent ``AbstractMathProgModel`` type):
37+
### Using with **[JuMP](https://github.com/JuMP.jl)**
4038

39+
Use `Cbc.Optimizer` to use Cbc with JuMP:
4140
```julia
4241
using Cbc
43-
using MathProgBase
44-
mixintprog(..., CbcSolver(Option1=value1,Option2=value2,...))
42+
using JuMP
43+
model = Model(with_optimizer(Cbc.Optimizer, logLevel=1))
4544
```
4645

47-
see the MathProgBase documentation for further information.
48-
4946
Options are solver-dependent, and unfortunately not well documented.
47+
5048
The following options are likely to be the most useful:
5149

5250
* ``seconds`` -- Solution timeout limit. (Must be a ``Float64``)
@@ -59,8 +57,6 @@ The following options are likely to be the most useful:
5957

6058
The complete list of parameters can be found by running the ``cbc`` executable and typing ``?`` at the prompt.
6159

62-
In addition, we provide the julia-specific option ``check_warmstart`` which, if set to ``false``, will tell the wrapper to pass along the warmstart solution regardless of if it satisfies the constraints of the problem. The default value is ``true``.
63-
6460
### Using the C interface
6561

6662
The low-level C interface is available in the ``CbcCInterface`` submodule:
@@ -71,4 +67,3 @@ using Cbc.CbcCInterface
7167
Using this interface is not recommended.
7268

7369
[Cbc]: https://projects.coin-or.org/Cbc
74-
[MathProgBase]: https://github.com/JuliaOpt/MathProgBase.jl

0 commit comments

Comments
 (0)