Skip to content

Commit

Permalink
[README] Update now that HiGHS is registered (#33)
Browse files Browse the repository at this point in the history
  • Loading branch information
odow authored Feb 11, 2021
1 parent edc8bc3 commit 1dd4c5d
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,24 @@ arguments are identical to the C API.

**Minimum version requirement:** HiGHS.jl requres at least Julia v1.3.

The package is not registered in the [General registry](https://github.com/JuliaRegistries/General/)
and so must be installed as follows:

Install HiGHS as follows:
```julia
import Pkg
Pkg.add(Pkg.PackageSpec(url="https://github.com/jump-dev/HiGHS.jl"))
Pkg.add("HiGHS")
```

In addition to installing the HiGHS.jl package, this will also download and
install the HiGHS binaries. (You do not need to install HiGHS separately.)

## Use with JuMP

Pass `HiGHS.Optimizer` to `JuMP.Model` to create a JuMP model with HiGHS as the
optimizer. Set options using `set_optimizer_attribute`.

```julia
using JuMP
import HiGHS
model = Model(HiGHS.Optimizer)
set_optimizer_attribute(model, "presolve", "on")
set_optimizer_attribute(model, "time_limit", 60.0)
```

0 comments on commit 1dd4c5d

Please sign in to comment.