search

Breakthrough-Energy / REISE.jl

Renewable Energy Integration Simulation Engine
https://breakthrough-energy.github.io/docs/
MIT License
30 stars 22 forks source link

refactor: improve error messaging for Gurobi environment issues #151

Closed danielolsen closed 3 years ago

danielolsen commented 3 years ago

Pull Request doc

Purpose

Currently, if there is an error in setting up a Gurobi environment (e.g. if a Gurobi license file is not present), then calling Gurobi.Env() will fail, and the JuMP model that would get stored in the variable m will not get created, and will not be available when we try to clean up the model and the connection to Gurobi with the finalize commands in the finally block, which will cause an error with the variable not being defined.

What the code is doing

More try/catch branching, so that if Gurobi fails (rather than something in model building/execution step) we return that error right away.

Testing

Running from the command-line using call.py, before:

JULIA: UndefVarError: m not defined
Stacktrace:
 [1] run_scenario_gurobi(; solver_kwargs::Nothing, kwargs::Base.Iterators.Pairs{Symbol,Any,NTuple{7,Symbol},NamedTuple{(:interval, :n_interval, :start_index, :inputfolder, :outputfolder, :threads, :num_segments),Tuple{Int64,Int64,Int64,String,Nothing,Nothing,Int64}}}) at C:\Users\DanielOlsen\repos\bes\REISE.jl\src\solver_specific\gurobi.jl:12
 [2] (::Base.var"#inner#2"{Base.Iterators.Pairs{Symbol,Any,NTuple{8,Symbol},NamedTuple{(:interval, :n_interval, :start_index, :inputfolder, :outputfolder, :threads, :solver_kwargs, :num_segments),Tuple{Int64,Int64,Int64,String,Nothing,Nothing,Nothing,Int64}}},typeof(REISE.run_scenario_gurobi),Tuple{}})() at .\essentials.jl:713
 [3] #invokelatest#1 at .\essentials.jl:714 [inlined]
 [4] _pyjlwrap_call(::Function, ::Ptr{PyCall.PyObject_struct}, ::Ptr{PyCall.PyObject_struct}) at C:\Users\DanielOlsen\.julia\packages\PyCall\BD546\src\callback.jl:32
 [5] pyjlwrap_call(::Ptr{PyCall.PyObject_struct}, ::Ptr{PyCall.PyObject_struct}, ::Ptr{PyCall.PyObject_struct}) at C:\Users\DanielOlsen\.julia\packages\PyCall\BD546\src\callback.jl:44>

after (no license file):

Error encountered starting Gurobi.
<PyCall.jlwrap (in a Julia function called from Python)
JULIA: Gurobi Error 10009: No Gurobi license found (user danielolsen, host BE-003412401557, hostid b64e83e1, cores 4)
Stacktrace:
 [1] run_scenario_gurobi(; solver_kwargs::Nothing, kwargs::Base.Iterators.Pairs{Symbol,Any,NTuple{7,Symbol},NamedTuple{(:interval, :n_interval, :start_index, :inputfolder, :outputfolder, :threads, :num_segments),Tuple{Int64,Int64,Int64,String,Nothing,Nothing,Int64}}}) at C:\Users\DanielOlsen\repos\bes\REISE.jl\src\solver_specific\gurobi.jl:11
 [2] (::Base.var"#inner#2"{Base.Iterators.Pairs{Symbol,Any,NTuple{8,Symbol},NamedTuple{(:interval, :n_interval, :start_index, :inputfolder, :outputfolder, :threads, :solver_kwargs, :num_segments),Tuple{Int64,Int64,Int64,String,Nothing,Nothing,Nothing,Int64}}},typeof(REISE.run_scenario_gurobi),Tuple{}})() at .\essentials.jl:713
 [3] #invokelatest#1 at .\essentials.jl:714 [inlined]
 [4] _pyjlwrap_call(::Function, ::Ptr{PyCall.PyObject_struct}, ::Ptr{PyCall.PyObject_struct}) at C:\Users\DanielOlsen\.julia\packages\PyCall\BD546\src\callback.jl:32
 [5] pyjlwrap_call(::Ptr{PyCall.PyObject_struct}, ::Ptr{PyCall.PyObject_struct}, ::Ptr{PyCall.PyObject_struct}) at C:\Users\DanielOlsen\.julia\packages\PyCall\BD546\src\callback.jl:44>

When the license file is there, everything still proceeds as expected.

Time estimate

5 minutes.

danielolsen commented 3 years ago

Looks good to me! Thank you for doing this. I encountered this exact problem a couple weeks ago when my academic license had lapsed. It took quite a while to find the actual problem.

Interesting. Was this in a native install, or with plug? With plug, and a Academic Web License Service file, I've seen one example of (what I think is) the license file being read properly, and the model is being created, but then the process is simply killed before solving any intervals. It seems like it's either due to being run when not connected to a university network, or it's a container RAM limitation issue.

lanesmith commented 3 years ago

Interesting. Was this in a native install, or with plug? With plug, and a Academic Web License Service file, I've seen one example of (what I think is) the license file being read properly, and the model is being created, but then the process is simply killed before solving any intervals. It seems like it's either due to being run when not connected to a university network, or it's a container RAM limitation issue.

It was with native installs of REISE.jl and Gurobi, so I was using an individual academic license, which I'm almost certain doesn't require a connection to a university network.