Skip to content

Commit

Permalink
doc: add solver specification to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
danielolsen committed Jan 28, 2021
1 parent 2211ec8 commit 748b028
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,14 @@ REISE.run_scenario(;
interval=24, n_interval=3, start_index=1, outputfolder="output",
inputfolder=pwd(), num_segments=3)
```
If another solver is desired, it can be passed via the `optimizer_factory` argument, e.g.:
```julia
import GLPK
REISE.run_scenario(;
interval=24, n_interval=3, start_index=1, outputfolder="output",
inputfolder=pwd(), optimizer_factory=GLPK.Optimizer)
```
Be sure to pass the factory itself (e.g. `GLPK.Optimizer`) rather than an instance (e.g. `GLPK.Optimizer()`). See the [JuMP.Model documentation] for more information.

## Usage (Python)

Expand Down Expand Up @@ -665,3 +673,4 @@ Penalty for ending the interval with less stored energy than the start, or rewar

[Gurobi.jl]: https://github.com/JuliaOpt/Gurobi.jl#installation
[Julia Package Manager]: https://julialang.github.io/Pkg.jl/v1/managing-packages/
[JuMP.Model documentation]: https://jump.dev/JuMP.jl/stable/solvers/#JuMP.Model-Tuple{Any}

0 comments on commit 748b028

Please sign in to comment.